MarketplaceCatalog

public struct MarketplaceCatalog

Client object for interacting with AWS MarketplaceCatalog service.

Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace. You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.

Member variables

Initialization

  • Initialize the MarketplaceCatalog client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.

    Declaration

    Swift

    public func cancelChangeSet(_ input: CancelChangeSetRequest) -> EventLoopFuture<CancelChangeSetResponse>

  • Provides information about a given change set.

    Declaration

    Swift

    public func describeChangeSet(_ input: DescribeChangeSetRequest) -> EventLoopFuture<DescribeChangeSetResponse>

  • Returns the metadata and content of the entity.

    Declaration

    Swift

    public func describeEntity(_ input: DescribeEntityRequest) -> EventLoopFuture<DescribeEntityResponse>

  • Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls.

    Declaration

    Swift

    public func listChangeSets(_ input: ListChangeSetsRequest) -> EventLoopFuture<ListChangeSetsResponse>

  • Provides the list of entities of a given type.

    Declaration

    Swift

    public func listEntities(_ input: ListEntitiesRequest) -> EventLoopFuture<ListEntitiesResponse>

  • This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException. For example, you cannot start the ChangeSet described in the example below because it contains two changes to execute the same change type (AddRevisions) against the same entity (entity-id@1).

    Declaration

    Swift

    public func startChangeSet(_ input: StartChangeSetRequest) -> EventLoopFuture<StartChangeSetResponse>

Paginators

  • Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls.

    Declaration

    Swift

    public func listChangeSetsPaginator(_ input: ListChangeSetsRequest, onPage: @escaping (ListChangeSetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Provides the list of entities of a given type.

    Declaration

    Swift

    public func listEntitiesPaginator(_ input: ListEntitiesRequest, onPage: @escaping (ListEntitiesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ChangeStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SortOrder : String, CustomStringConvertible, Codable