The AWS Marketplace Catalog Service API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Change (p. 81)
• ChangeSetSummaryListItem (p. 83)
• ChangeSummary (p. 85)
• Entity (p. 87)
• EntitySummary (p. 88)
• ErrorDetail (p. 90)
• Filter (p. 91)
• Sort (p. 93)
Change
Change
An object that contains the ChangeType, Details, and Entity.
Contents
ChangeName
Optional name for the change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 72.
Pattern: ^[a-zA-Z]$
Required: No ChangeType
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[A-Z][\w]*$
Required: Yes Details
This object contains details specific to the change type of the requested change.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16384.
Pattern: ^[\s]*\{[\s\S]*\}[\s]*$
Required: Yes Entity
The entity to be changed.
Type: Entity (p. 87) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
ChangeSetSummaryListItem
ChangeSetSummaryListItem
A summary of a change set returned in a list of change sets when the ListChangeSets action is called.
Contents
ChangeSetArn
The ARN associated with the unique identifier for the change set referenced in this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[a-zA-Z0-9:*/-]+$
Required: No ChangeSetId
The unique identifier for a change set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[\w\-]+$
Required: No ChangeSetName
The non-unique name for the change set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w\s+=.:@-]+$
Required: No EndTime
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
Type: String
Length Constraints: Fixed length of 20.
Pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01]
[\d]):([0-5][\d]):([0-5][\d])Z$
Required: No EntityIdList
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.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
See Also
Pattern: ^[\w\-]+$
Required: No FailureCode
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.
Type: String
Valid Values: CLIENT_ERROR | SERVER_FAULT Required: No
StartTime
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
Type: String
Length Constraints: Fixed length of 20.
Pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01]
[\d]):([0-5][\d]):([0-5][\d])Z$
Required: No Status
The current status of the change set.
Type: String
Valid Values: PREPARING | APPLYING | SUCCEEDED | CANCELLED | FAILED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ChangeSummary
ChangeSummary
This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.
Contents
ChangeName
Optional name for the change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 72.
Pattern: ^[a-zA-Z]$
Required: No ChangeType
The type of the change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[A-Z][\w]*$
Required: No Details
This object contains details specific to the change type of the requested change.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16384.
Pattern: ^[\s]*\{[\s\S]*\}[\s]*$
Required: No Entity
The entity to be changed.
Type: Entity (p. 87) object Required: No
ErrorDetailList
An array of ErrorDetail objects associated with the change.
Type: Array of ErrorDetail (p. 90) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Entity
Entity
An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer.
Contents
Identifier
The identifier for the entity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[\w\-@]+$
Required: No Type
The type of entity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z]+$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EntitySummary
EntitySummary
This object is a container for common summary information about the entity. The summary doesn't contain the whole entity structure, but it does contain information common across all entities.
Contents
EntityArn
The ARN associated with the unique identifier for the entity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[a-zA-Z0-9:*/-]+$
Required: No EntityId
The unique identifier for the entity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[\w\-]+$
Required: No EntityType
The type of the entity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z]+$
Required: No LastModifiedDate
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
Type: String
Length Constraints: Fixed length of 20.
Pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01]
[\d]):([0-5][\d]):([0-5][\d])Z$
Required: No Name
The name for the entity. This value is not unique. It is defined by the seller.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
See Also
Pattern: ^\\S+[\\S\\s]*
Required: No Visibility
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).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ErrorDetail
ErrorDetail
Details about the error.
Contents
ErrorCode
The error code that identifies the type of error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 72.
Pattern: ^[a-zA-Z_]+$
Required: No ErrorMessage
The message for the error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^(.)+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Filter
Filter
A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.
Contents
Name
For ListEntities, the supported value for this is an EntityId.
For ListChangeSets, the supported values are as follows:
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z]+$
Required: No ValueList
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.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^(.)+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Sort
Sort
An object that contains two attributes, SortBy and SortOrder.
Contents
SortBy
For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name.
For ListChangeSets, supported attributes include StartTime and EndTime.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z]+$
Required: No SortOrder
The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Type: String
Valid Values: ASCENDING | DESCENDING Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3