You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MarketplaceCatalog

Inherits:

AWS.Service

Object
AWS.Service
AWS.MarketplaceCatalog

show all

Identifier:: marketplacecatalog

API Version:: 2018-09-17

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using MarketplaceCatalog

var marketplacecatalog = new AWS.MarketplaceCatalog();
marketplacecatalog.cancelChangeSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MarketplaceCatalog object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var marketplacecatalog = new AWS.MarketplaceCatalog({apiVersion: '2018-09-17'});

You can also set the API version globally in AWS.config.apiVersions using the marketplacecatalog service identifier:

AWS.config.apiVersions = {
  marketplacecatalog: '2018-09-17',
  // other service API versions
};

var marketplacecatalog = new AWS.MarketplaceCatalog();

Version:

2018-09-17

Constructor Summary collapse

new AWS.MarketplaceCatalog(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

cancelChangeSet(params = {}, callback) ⇒ AWS.Request
Used to cancel an open change request.
describeChangeSet(params = {}, callback) ⇒ AWS.Request
Provides information about a given change set.

.
describeEntity(params = {}, callback) ⇒ AWS.Request
Returns the metadata and content of the entity.

.
listChangeSets(params = {}, callback) ⇒ AWS.Request
Returns the list of change sets owned by the account being used to make the call.
listEntities(params = {}, callback) ⇒ AWS.Request
Provides the list of entities of a given type.

.
startChangeSet(params = {}, callback) ⇒ AWS.Request
This operation allows you to request changes for your entities.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MarketplaceCatalog(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MarketplaceCatalog object

var marketplacecatalog = new AWS.MarketplaceCatalog({apiVersion: '2018-09-17'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.MarketplaceCatalog.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.MarketplaceCatalog.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.MarketplaceCatalog.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelChangeSet(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

CancelChangeSet

Examples:

Calling the cancelChangeSet operation

var params = {
  Catalog: 'STRING_VALUE', /* required */
  ChangeSetId: 'STRING_VALUE' /* required */
};
marketplacecatalog.cancelChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Catalog — (String)
  Required. The catalog related to the request. Fixed value: AWSMarketplace.
- ChangeSetId — (String)
  Required. The unique identifier of the StartChangeSet request that you want to cancel.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ChangeSetId — (String)
    The unique identifier for the change set referenced in this request.
  - ChangeSetArn — (String)
    The ARN associated with the change set referenced in this request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeChangeSet(params = {}, callback) ⇒ `AWS.Request`

Provides information about a given change set.

Service Reference:

DescribeChangeSet

Examples:

Calling the describeChangeSet operation

var params = {
  Catalog: 'STRING_VALUE', /* required */
  ChangeSetId: 'STRING_VALUE' /* required */
};
marketplacecatalog.describeChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Catalog — (String)
  Required. The catalog related to the request. Fixed value: AWSMarketplace
- ChangeSetId — (String)
  Required. The unique identifier for the StartChangeSet request that you want to describe the details for.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ChangeSetId — (String)
    Required. The unique identifier for the change set referenced in this request.
  - ChangeSetArn — (String)
    The ARN associated with the unique identifier for the change set referenced in this request.
  - ChangeSetName — (String)
    The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.
  - StartTime — (String)
    The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.
  - EndTime — (String)
    The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state.
  - Status — (String)
    The status of the change request.
    Possible values include:
    
    "PREPARING"
    
    "APPLYING"
    
    "SUCCEEDED"
    
    "CANCELLED"
    
    "FAILED"
  - FailureCode — (String)
    Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.
    Possible values include:
    
    "CLIENT_ERROR"
    
    "SERVER_FAULT"
  - FailureDescription — (String)
    Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.
  - ChangeSet — (Array<map>)
    An array of ChangeSummary objects.
    
    ChangeType — (String)
    The type of the change.
    
    Entity — (map)
    The entity to be changed.
    
    Type — required — (String)
    The type of entity.
    
    Identifier — (String)
    The identifier for the entity.
    
    Details — (String)
    This object contains details specific to the change type of the requested change.
    
    ErrorDetailList — (Array<map>)
    An array of ErrorDetail objects associated with the change.
    
    ErrorCode — (String)
    The error code that identifies the type of error.
    
    ErrorMessage — (String)
    The message for the error.
    
    ChangeName — (String)
    Optional name for the change.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeEntity(params = {}, callback) ⇒ `AWS.Request`

Returns the metadata and content of the entity.

Service Reference:

DescribeEntity

Examples:

Calling the describeEntity operation

var params = {
  Catalog: 'STRING_VALUE', /* required */
  EntityId: 'STRING_VALUE' /* required */
};
marketplacecatalog.describeEntity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Catalog — (String)
  Required. The catalog related to the request. Fixed value: AWSMarketplace
- EntityId — (String)
  Required. The unique ID of the entity to describe.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - EntityType — (String)
    The named type of the entity, in the format of EntityType@Version.
  - EntityIdentifier — (String)
    The identifier of the entity, in the format of EntityId@RevisionId.
  - EntityArn — (String)
    The ARN associated to the unique identifier for the change set referenced in this request.
  - LastModifiedDate — (String)
    The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
  - Details — (String)
    This stringified JSON object includes the details of the entity.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listChangeSets(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

ListChangeSets

Examples:

Calling the listChangeSets operation

var params = {
  Catalog: 'STRING_VALUE', /* required */
  FilterList: [
    {
      Name: 'STRING_VALUE',
      ValueList: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Sort: {
    SortBy: 'STRING_VALUE',
    SortOrder: ASCENDING | DESCENDING
  }
};
marketplacecatalog.listChangeSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Catalog — (String)
  The catalog related to the request. Fixed value: AWSMarketplace
- FilterList — (Array<map>)
  An array of filter objects.
  - Name — (String)
    For ListEntities, the supported value for this is an EntityId.
    
    For ListChangeSets, the supported values are as follows:
  - ValueList — (Array<String>)
    ListEntities - This is a list of unique EntityIds.
    
    ListChangeSets - The supported filter names and associated ValueLists is as follows:
    - ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the StartChangeSet action.
    - Status - The supported ValueList is a list of statuses for all change set requests.
    - EntityId - The supported ValueList is a list of unique EntityIds.
    - BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.
    - AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.
    - BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.
    - AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.
- Sort — (map)
  An object that contains two attributes, SortBy and SortOrder.
  - SortBy — (String)
    For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name.
    
    For ListChangeSets, supported attributes include StartTime and EndTime.
  - SortOrder — (String)
    The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
    Possible values include:
    - "ASCENDING"
    - "DESCENDING"
- MaxResults — (Integer)
  The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.
- NextToken — (String)
  The token value retrieved from a previous call to access the next page of results.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ChangeSetSummaryList — (Array<map>)
    Array of ChangeSetSummaryListItem objects.
    
    ChangeSetId — (String)
    The unique identifier for a change set.
    
    ChangeSetArn — (String)
    The ARN associated with the unique identifier for the change set referenced in this request.
    
    ChangeSetName — (String)
    The non-unique name for the change set.
    
    StartTime — (String)
    The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
    
    EndTime — (String)
    The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
    
    Status — (String)
    The current status of the change set.
    Possible values include:
    
    "PREPARING"
    
    "APPLYING"
    
    "SUCCEEDED"
    
    "CANCELLED"
    
    "FAILED"
    
    EntityIdList — (Array<String>)
    This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of 20 entities. It must contain at least one entity.
    
    FailureCode — (String)
    Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList of DescribeChangeSet), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.
    Possible values include:
    
    "CLIENT_ERROR"
    
    "SERVER_FAULT"
  - NextToken — (String)
    The value of the next token, if it exists. Null if there are no more results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listEntities(params = {}, callback) ⇒ `AWS.Request`

Provides the list of entities of a given type.

Service Reference:

ListEntities

Examples:

Calling the listEntities operation

var params = {
  Catalog: 'STRING_VALUE', /* required */
  EntityType: 'STRING_VALUE', /* required */
  FilterList: [
    {
      Name: 'STRING_VALUE',
      ValueList: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Sort: {
    SortBy: 'STRING_VALUE',
    SortOrder: ASCENDING | DESCENDING
  }
};
marketplacecatalog.listEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Catalog — (String)
  The catalog related to the request. Fixed value: AWSMarketplace
- EntityType — (String)
  The type of entities to retrieve.
- FilterList — (Array<map>)
  An array of filter objects. Each filter object contains two attributes, filterName and filterValues.
  - Name — (String)
    For ListEntities, the supported value for this is an EntityId.
    
    For ListChangeSets, the supported values are as follows:
  - ValueList — (Array<String>)
    ListEntities - This is a list of unique EntityIds.
    
    ListChangeSets - The supported filter names and associated ValueLists is as follows:
    - ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the StartChangeSet action.
    - Status - The supported ValueList is a list of statuses for all change set requests.
    - EntityId - The supported ValueList is a list of unique EntityIds.
    - BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.
    - AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.
    - BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.
    - AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.
- Sort — (map)
  An object that contains two attributes, SortBy and SortOrder.
  - SortBy — (String)
    For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name.
    
    For ListChangeSets, supported attributes include StartTime and EndTime.
  - SortOrder — (String)
    The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
    Possible values include:
    - "ASCENDING"
    - "DESCENDING"
- NextToken — (String)
  The value of the next token, if it exists. Null if there are no more results.
- MaxResults — (Integer)
  Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - EntitySummaryList — (Array<map>)
    Array of EntitySummary object.
    
    Name — (String)
    The name for the entity. This value is not unique. It is defined by the seller.
    
    EntityType — (String)
    The type of the entity.
    
    EntityId — (String)
    The unique identifier for the entity.
    
    EntityArn — (String)
    The ARN associated with the unique identifier for the entity.
    
    LastModifiedDate — (String)
    The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
    
    Visibility — (String)
    The visibility status of the entity to buyers. This value can be Public (everyone can view the entity), Limited (the entity is visible to limited accounts only), or Restricted (the entity was published and then unpublished and only existing buyers can view it).
  - NextToken — (String)
    The value of the next token if it exists. Null if there is no more result.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

startChangeSet(params = {}, callback) ⇒ `AWS.Request`

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 later in this topic, because it contains two changes to execute the same change type (AddRevisions) against the same entity (entity-id@1).

For more information about working with change sets, see Working with change sets.

Service Reference:

StartChangeSet

Examples:

Calling the startChangeSet operation

var params = {
  Catalog: 'STRING_VALUE', /* required */
  ChangeSet: [ /* required */
    {
      ChangeType: 'STRING_VALUE', /* required */
      Details: 'STRING_VALUE', /* required */
      Entity: { /* required */
        Type: 'STRING_VALUE', /* required */
        Identifier: 'STRING_VALUE'
      },
      ChangeName: 'STRING_VALUE'
    },
    /* more items */
  ],
  ChangeSetName: 'STRING_VALUE',
  ClientRequestToken: 'STRING_VALUE'
};
marketplacecatalog.startChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Catalog — (String)
  The catalog related to the request. Fixed value: AWSMarketplace
- ChangeSet — (Array<map>)
  Array of change object.
  - ChangeType — required — (String)
    Change types are single string values that describe your intention for the change. Each change type is unique for each EntityType provided in the change's scope.
  - Entity — required — (map)
    The entity to be changed.
    - Type — required — (String)
      The type of entity.
    - Identifier — (String)
      The identifier for the entity.
  - Details — required — (String)
    This object contains details specific to the change type of the requested change.
  - ChangeName — (String)
    Optional name for the change.
- ChangeSetName — (String)
  Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.
- ClientRequestToken — (String)
  A unique token to identify the request to ensure idempotency.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ChangeSetId — (String)
    Unique identifier generated for the request.
  - ChangeSetArn — (String)
    The ARN associated to the unique identifier generated for the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.MarketplaceCatalog

Overview

Service Description

Sending a Request Using MarketplaceCatalog

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.MarketplaceCatalog(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

cancelChangeSet(params = {}, callback) ⇒ AWS.Request

describeChangeSet(params = {}, callback) ⇒ AWS.Request

describeEntity(params = {}, callback) ⇒ AWS.Request

listChangeSets(params = {}, callback) ⇒ AWS.Request

listEntities(params = {}, callback) ⇒ AWS.Request

startChangeSet(params = {}, callback) ⇒ AWS.Request

new AWS.MarketplaceCatalog(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

cancelChangeSet(params = {}, callback) ⇒ `AWS.Request`

describeChangeSet(params = {}, callback) ⇒ `AWS.Request`

describeEntity(params = {}, callback) ⇒ `AWS.Request`

listChangeSets(params = {}, callback) ⇒ `AWS.Request`

listEntities(params = {}, callback) ⇒ `AWS.Request`

startChangeSet(params = {}, callback) ⇒ `AWS.Request`