AmiProductEntityIdFilter entityId
Unique identifier for the AMI product.
AmiProductLastModifiedDateFilter lastModifiedDate
The last date on which the AMI product was modified.
AmiProductTitleFilter productTitle
The title of the AMI product.
AmiProductVisibilityFilter visibility
The visibility of the AMI product.
AmiProductLastModifiedDateFilterDateRange dateRange
Dates between which the AMI product was last modified.
String 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. For more information about change types available
for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for
container-based products, see Working with container products.
Entity entity
The entity to be changed.
List<E> entityTags
The tags associated with the change.
String details
This object contains details specific to the change type of the requested change. For more information about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.
String changeName
Optional name for the change.
String changeSetId
The unique identifier for a change set.
String changeSetArn
The ARN associated with the unique identifier for the change set referenced in this request.
String changeSetName
The non-unique name for the change set.
String startTime
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
String endTime
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
String status
The current status of the change set.
List<E> 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.
String 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.
String changeType
The type of the change.
Entity entity
The entity to be changed.
String details
This object contains details specific to the change type of the requested change.
List<E> errorDetailList
An array of ErrorDetail objects associated with the change.
String changeName
Optional name for the change.
ContainerProductEntityIdFilter entityId
Unique identifier for the container product.
ContainerProductLastModifiedDateFilter lastModifiedDate
The last date on which the container product was modified.
ContainerProductTitleFilter productTitle
The title of the container product.
ContainerProductVisibilityFilter visibility
The visibility of the container product.
ContainerProductLastModifiedDateFilterDateRange dateRange
Dates between which the container product was last modified.
DataProductEntityIdFilter entityId
Unique identifier for the data product.
DataProductTitleFilter productTitle
The title of the data product.
DataProductVisibilityFilter visibility
The visibility of the data product.
DataProductLastModifiedDateFilter lastModifiedDate
The last date on which the data product was modified.
DataProductLastModifiedDateFilterDateRange dateRange
Dates between which the data product was last modified.
String resourceArn
The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.
String changeSetId
Required. The unique identifier for the change set referenced in this request.
String changeSetArn
The ARN associated with the unique identifier for the change set referenced in this request.
String changeSetName
The optional name provided in the StartChangeSet request. If you do not provide a name, one is set
by default.
String intent
The optional intent provided in the StartChangeSet request. If you do not provide an intent,
APPLY is set by default.
String startTime
The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.
String endTime
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.
String status
The status of the change request.
String 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), or SERVER_FAULT,
which means that there is a problem in the system, and you should retry your request.
String failureDescription
Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.
List<E> changeSet
An array of ChangeSummary objects.
String entityType
The named type of the entity, in the format of EntityType@Version.
String entityIdentifier
The identifier of the entity, in the format of EntityId@RevisionId.
String entityArn
The ARN associated to the unique identifier for the entity referenced in this request.
String lastModifiedDate
The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
String details
This stringified JSON object includes the details of the entity.
String entityType
The entity type of the entity, in the format of EntityType@Version.
String entityArn
The Amazon Resource Name (ARN) of the entity.
String entityIdentifier
The ID of the entity, in the format of EntityId@RevisionId.
String lastModifiedDate
The last time the entity was modified.
String name
The name for the entity. This value is not unique. It is defined by the seller.
String entityType
The type of the entity.
String entityId
The unique identifier for the entity.
String entityArn
The ARN associated with the unique identifier for the entity.
String lastModifiedDate
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
String 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).
AmiProductSummary amiProductSummary
An object that contains summary information about the AMI product.
ContainerProductSummary containerProductSummary
An object that contains summary information about the container product.
DataProductSummary dataProductSummary
An object that contains summary information about the data product.
SaaSProductSummary saaSProductSummary
An object that contains summary information about the SaaS product.
OfferSummary offerSummary
An object that contains summary information about the offer.
ResaleAuthorizationSummary resaleAuthorizationSummary
An object that contains summary information about the Resale Authorization.
DataProductFilters dataProductFilters
A filter for data products.
SaaSProductFilters saaSProductFilters
A filter for SaaS products.
AmiProductFilters amiProductFilters
A filter for AMI products.
OfferFilters offerFilters
A filter for offers.
ContainerProductFilters containerProductFilters
A filter for container products.
ResaleAuthorizationFilters resaleAuthorizationFilters
A filter for Resale Authorizations.
DataProductSort dataProductSort
A sort for data products.
SaaSProductSort saaSProductSort
A sort for SaaS products.
AmiProductSort amiProductSort
A sort for AMI products.
OfferSort offerSort
A sort for offers.
ContainerProductSort containerProductSort
A sort for container products.
ResaleAuthorizationSort resaleAuthorizationSort
A sort for Resale Authorizations.
String name
For ListEntities, the supported value for this is an EntityId.
For ListChangeSets, the supported values are as follows:
List<E> 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.
String resourceArn
The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.
String policy
The policy document to set; formatted in JSON.
String catalog
The catalog related to the request. Fixed value: AWSMarketplace
List<E> filterList
An array of filter objects.
Sort sort
An object that contains two attributes, SortBy and SortOrder.
Integer maxResults
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.
String nextToken
The token value retrieved from a previous call to access the next page of results.
String catalog
The catalog related to the request. Fixed value: AWSMarketplace
String entityType
The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct,
DataProduct, SaaSProduct, ProcurementPolicy, Experience,
Audience, BrandingSettings, Offer, Seller,
ResaleAuthorization.
List<E> filterList
An array of filter objects. Each filter object contains two attributes, filterName and
filterValues.
Sort sort
An object that contains two attributes, SortBy and SortOrder.
String nextToken
The value of the next token, if it exists. Null if there are no more results.
Integer maxResults
Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
String ownershipType
Filters the returned set of entities based on their owner. The default is SELF. To list entities
shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared
through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the
SHARED parameter.
EntityTypeFilters entityTypeFilters
A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter
shape will have filters applicable for that EntityType that can be used to search or filter
entities.
EntityTypeSort entityTypeSort
A Union object containing Sort shapes for all EntityTypes. Each
EntityTypeSort shape will have SortBy and SortOrder applicable for fields
on that EntityType. This can be used to sort the results of the filter query.
String resourceArn
Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
OfferAvailabilityEndDateFilterDateRange dateRange
Allows filtering on the AvailabilityEndDate of an offer with date range as input.
String wildCardValue
Allows filtering on the BuyerAccounts of an offer with wild card input.
OfferEntityIdFilter entityId
Allows filtering on EntityId of an offer.
OfferNameFilter name
Allows filtering on the Name of an offer.
OfferProductIdFilter productId
Allows filtering on the ProductId of an offer.
OfferResaleAuthorizationIdFilter resaleAuthorizationId
Allows filtering on the ResaleAuthorizationId of an offer.
Not all offers have a ResaleAuthorizationId. The response will only include offers for which you
have permissions.
OfferReleaseDateFilter releaseDate
Allows filtering on the ReleaseDate of an offer.
OfferAvailabilityEndDateFilter availabilityEndDate
Allows filtering on the AvailabilityEndDate of an offer.
OfferBuyerAccountsFilter buyerAccounts
Allows filtering on the BuyerAccounts of an offer.
OfferStateFilter state
Allows filtering on the State of an offer.
OfferTargetingFilter targeting
Allows filtering on the Targeting of an offer.
OfferLastModifiedDateFilter lastModifiedDate
Allows filtering on the LastModifiedDate of an offer.
OfferLastModifiedDateFilterDateRange dateRange
Allows filtering on the LastModifiedDate of an offer with date range as input.
OfferReleaseDateFilterDateRange dateRange
Allows filtering on the ReleaseDate of an offer with date range as input.
String name
The name of the offer.
String productId
The product ID of the offer.
String resaleAuthorizationId
The ResaleAuthorizationId of the offer.
String releaseDate
The release date of the offer.
String availabilityEndDate
The availability end date of the offer.
List<E> buyerAccounts
The buyer accounts in the offer.
String state
The status of the offer.
List<E> targeting
The targeting in the offer.
ResaleAuthorizationAvailabilityEndDateFilterDateRange dateRange
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input
List<E> valueList
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date value as input.
ResaleAuthorizationCreatedDateFilterDateRange dateRange
Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.
List<E> valueList
Allows filtering on CreatedDate of a ResaleAuthorization with date value as input.
ResaleAuthorizationEntityIdFilter entityId
Allows filtering on the EntityId of a ResaleAuthorization.
ResaleAuthorizationNameFilter name
Allows filtering on the Name of a ResaleAuthorization.
ResaleAuthorizationProductIdFilter productId
Allows filtering on the ProductId of a ResaleAuthorization.
ResaleAuthorizationCreatedDateFilter createdDate
Allows filtering on the CreatedDate of a ResaleAuthorization.
ResaleAuthorizationAvailabilityEndDateFilter availabilityEndDate
Allows filtering on the AvailabilityEndDate of a ResaleAuthorization.
ResaleAuthorizationManufacturerAccountIdFilter manufacturerAccountId
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.
ResaleAuthorizationProductNameFilter productName
Allows filtering on the ProductName of a ResaleAuthorization.
ResaleAuthorizationManufacturerLegalNameFilter manufacturerLegalName
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.
ResaleAuthorizationResellerAccountIDFilter resellerAccountID
Allows filtering on the ResellerAccountID of a ResaleAuthorization.
ResaleAuthorizationResellerLegalNameFilter resellerLegalName
Allows filtering on the ResellerLegalName of a ResaleAuthorization.
ResaleAuthorizationStatusFilter status
Allows filtering on the Status of a ResaleAuthorization.
ResaleAuthorizationOfferExtendedStatusFilter offerExtendedStatus
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.
ResaleAuthorizationLastModifiedDateFilter lastModifiedDate
Allows filtering on the LastModifiedDate of a ResaleAuthorization.
ResaleAuthorizationLastModifiedDateFilterDateRange dateRange
Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.
String name
The name of the ResaleAuthorization.
String productId
The product ID of the ResaleAuthorization.
String productName
The product name of the ResaleAuthorization.
String manufacturerAccountId
The manufacturer account ID of the ResaleAuthorization.
String manufacturerLegalName
The manufacturer legal name of the ResaleAuthorization.
String resellerAccountID
The reseller account ID of the ResaleAuthorization.
String resellerLegalName
The reseller legal name of the ResaleAuthorization
String status
The status of the ResaleAuthorization.
String offerExtendedStatus
The offer extended status of the ResaleAuthorization
String createdDate
The created date of the ResaleAuthorization.
String availabilityEndDate
The availability end date of the ResaleAuthorization.
SaaSProductEntityIdFilter entityId
Unique identifier for the SaaS product.
SaaSProductTitleFilter productTitle
The title of the SaaS product.
SaaSProductVisibilityFilter visibility
The visibility of the SaaS product.
SaaSProductLastModifiedDateFilter lastModifiedDate
The last date on which the SaaS product was modified.
SaaSProductLastModifiedDateFilterDateRange dateRange
Dates between which the SaaS product was last modified.
String sortBy
For ListEntities, supported attributes include LastModifiedDate (default) and
EntityId. In addition to LastModifiedDate and EntityId, each
EntityType might support additional fields.
For ListChangeSets, supported attributes include StartTime and EndTime.
String sortOrder
The sorting order. Can be ASCENDING or DESCENDING. The default value is
DESCENDING.
String catalog
The catalog related to the request. Fixed value: AWSMarketplace
List<E> changeSet
Array of change object.
String changeSetName
Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.
String clientRequestToken
A unique token to identify the request to ensure idempotency.
List<E> changeSetTags
A list of objects specifying each key name and value for the ChangeSetTags property.
String intent
The intent related to the request. The default is APPLY. To test your request before applying
changes to your entities, use VALIDATE. This feature is currently available for adding versions to
single-AMI products. For more information, see Add
a new version.
Copyright © 2024. All rights reserved.