Object that allows filtering on entity id of an AMI product.
+ */ +export interface AmiProductEntityIdFilter { + /** + * @public + *A string array of unique entity id values to be filtered on.
+ */ + ValueList?: string[]; +} + +/** + * @public + *Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Date after which the AMI product was last modified.
+ */ + AfterValue?: string; + + /** + * @public + *Date before which the AMI product was last modified.
+ */ + BeforeValue?: string; +} + +/** + * @public + *Object that allows filtering based on the last modified date of AMI products.
+ */ +export interface AmiProductLastModifiedDateFilter { + /** + * @public + *Dates between which the AMI product was last modified.
+ */ + DateRange?: AmiProductLastModifiedDateFilterDateRange; +} + +/** + * @public + *Object that allows filtering on product title.
+ */ +export interface AmiProductTitleFilter { + /** + * @public + *A string array of unique product title values to be filtered on.
+ */ + ValueList?: string[]; + + /** + * @public + *A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on the visibility of the product in the AWS Marketplace.
+ */ +export interface AmiProductVisibilityFilter { + /** + * @public + *A string array of unique visibility values to be filtered on.
+ */ + ValueList?: AmiProductVisibilityString[]; +} + +/** + * @public + *Object containing all the filter fields for AMI products. Client can add a maximum of 8
+ * filters in a single ListEntities request.
Unique identifier for the AMI product.
+ */ + EntityId?: AmiProductEntityIdFilter; + + /** + * @public + *The last date on which the AMI product was modified.
+ */ + LastModifiedDate?: AmiProductLastModifiedDateFilter; + + /** + * @public + *The title of the AMI product.
+ */ + ProductTitle?: AmiProductTitleFilter; + + /** + * @public + *The visibility of the AMI product.
+ */ + Visibility?: AmiProductVisibilityFilter; +} + +/** + * @public + * @enum + */ +export const AmiProductSortBy = { + EntityId: "EntityId", + LastModifiedDate: "LastModifiedDate", + ProductTitle: "ProductTitle", + Visibility: "Visibility", +} as const; + +/** + * @public + */ +export type AmiProductSortBy = (typeof AmiProductSortBy)[keyof typeof AmiProductSortBy]; + +/** + * @public + * @enum + */ +export const SortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; + +/** + * @public + */ +export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; + +/** + * @public + *Objects that allows sorting on AMI products based on certain fields and sorting order.
+ */ +export interface AmiProductSort { + /** + * @public + *Field to sort the AMI products by.
+ */ + SortBy?: AmiProductSortBy; + + /** + * @public + *The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Object that contains summarized information about an AMI product.
+ */ +export interface AmiProductSummary { + /** + * @public + *The title of the AMI product.
+ */ + ProductTitle?: string; + + /** + * @public + *The lifecycle of the AMI product.
+ */ + Visibility?: AmiProductVisibilityString; +} + /** * @public */ @@ -565,20 +750,6 @@ export interface Filter { ValueList?: string[]; } -/** - * @public - * @enum - */ -export const SortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", -} as const; - -/** - * @public - */ -export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; - /** * @public *An object that contains two attributes, SortBy and
@@ -726,119 +897,1790 @@ export interface ListChangeSetsResponse {
/**
* @public
- * @enum
+ *
Object that allows filtering on entity id of a container product.
*/ -export const OwnershipType = { - SELF: "SELF", - SHARED: "SHARED", -} as const; +export interface ContainerProductEntityIdFilter { + /** + * @public + *A string array of unique entity id values to be filtered on.
+ */ + ValueList?: string[]; +} /** * @public + *Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Date after which the container product was last modified.
+ */ + AfterValue?: string; + + /** + * @public + *Date before which the container product was last modified.
+ */ + BeforeValue?: string; +} /** * @public + *Object that allows filtering based on the last modified date of container products.
*/ -export interface ListEntitiesRequest { +export interface ContainerProductLastModifiedDateFilter { /** * @public - *The catalog related to the request. Fixed value: AWSMarketplace
- *
Dates between which the container product was last modified.
*/ - Catalog: string | undefined; + DateRange?: ContainerProductLastModifiedDateFilterDateRange; +} +/** + * @public + *Object that allows filtering on product title.
+ */ +export interface ContainerProductTitleFilter { /** * @public - *The type of entities to retrieve.
+ *A string array of unique product title values to be filtered on.
*/ - EntityType: string | undefined; + ValueList?: string[]; /** * @public - *An array of filter objects. Each filter object contains two attributes,
- * filterName and filterValues.
A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on the visibility of the product in the AWS Marketplace.
+ */ +export interface ContainerProductVisibilityFilter { /** * @public - *An object that contains two attributes, SortBy and
- * SortOrder.
A string array of unique visibility values to be filtered on.
*/ - Sort?: Sort; + ValueList?: ContainerProductVisibilityString[]; +} +/** + * @public + *Object containing all the filter fields for container products. Client can add a maximum of 8 filters in a single ListEntities request.
The value of the next token, if it exists. Null if there are no more results.
+ *Unique identifier for the container product.
*/ - NextToken?: string; + EntityId?: ContainerProductEntityIdFilter; /** * @public - *Specifies the upper limit of the elements on a single page. If a value isn't provided, - * the default value is 20.
+ *The last date on which the container product was modified.
*/ - MaxResults?: number; + LastModifiedDate?: ContainerProductLastModifiedDateFilter; /** * @public - *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.
The title of the container product.
*/ - OwnershipType?: OwnershipType; + ProductTitle?: ContainerProductTitleFilter; + + /** + * @public + *The visibility of the container product.
+ */ + Visibility?: ContainerProductVisibilityFilter; } /** * @public - *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.
+ *Object that allows filtering on entity id of a data product.
*/ -export interface EntitySummary { +export interface DataProductEntityIdFilter { /** * @public - *The name for the entity. This value is not unique. It is defined by the seller.
+ *A string array of unique entity id values to be filtered on.
*/ - Name?: string; + ValueList?: string[]; +} +/** + * @public + *Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
The type of the entity.
+ *Date after which the data product was last modified.
*/ - EntityType?: string; + AfterValue?: string; /** * @public - *The unique identifier for the entity.
+ *Date before which the data product was last modified.
*/ - EntityId?: string; + BeforeValue?: string; +} +/** + * @public + *Object that allows filtering based on the last modified date of data products.
+ */ +export interface DataProductLastModifiedDateFilter { /** * @public - *The ARN associated with the unique identifier for the entity.
+ *Dates between which the data product was last modified.
*/ - EntityArn?: string; + DateRange?: DataProductLastModifiedDateFilterDateRange; +} +/** + * @public + *Object that allows filtering on product title.
+ */ +export interface DataProductTitleFilter { /** * @public - *The last time the entity was published, using ISO 8601 format - * (2018-02-27T13:45:22Z).
+ *A string array of unique product title values to be filtered on.
*/ - LastModifiedDate?: string; + ValueList?: string[]; /** * @public - *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).
A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on the visibility of the product in the AWS Marketplace.
+ */ +export interface DataProductVisibilityFilter { + /** + * @public + *A string array of unique visibility values to be filtered on.
+ */ + ValueList?: DataProductVisibilityString[]; +} + +/** + * @public + *Object containing all the filter fields for data products. Client can add a maximum of 8 filters in a single ListEntities request.
Unique identifier for the data product.
+ */ + EntityId?: DataProductEntityIdFilter; + + /** + * @public + *The title of the data product.
+ */ + ProductTitle?: DataProductTitleFilter; + + /** + * @public + *The visibility of the data product.
+ */ + Visibility?: DataProductVisibilityFilter; + + /** + * @public + *The last date on which the data product was modified.
+ */ + LastModifiedDate?: DataProductLastModifiedDateFilter; +} + +/** + * @public + *Allows filtering on the AvailabilityEndDate of an offer with date range as input.
Allows filtering on the AvailabilityEndDate of an offer after a date.
Allows filtering on the AvailabilityEndDate of an offer before a date.
Allows filtering on the AvailabilityEndDate of an offer.
Allows filtering on the AvailabilityEndDate of an offer with date range as input.
Allows filtering on the BuyerAccounts of an offer.
Allows filtering on the BuyerAccounts of an offer with wild card input.
Allows filtering on the entity id of an offer.
+ */ +export interface OfferEntityIdFilter { + /** + * @public + *Allows filtering on entity id of an offer with list input.
+ */ + ValueList?: string[]; +} + +/** + * @public + *Allows filtering on the LastModifiedDate of an offer with date range as input.
Allows filtering on the LastModifiedDate of an offer after a date.
Allows filtering on the LastModifiedDate of an offer before a date.
Allows filtering on the LastModifiedDate of an offer.
Allows filtering on the LastModifiedDate of an offer with date range as input.
Allows filtering on the Name of an offer.
Allows filtering on the Name of an offer with list input.
Allows filtering on the Name of an offer with wild card input.
Allows filtering on the ProductId of an offer.
Allows filtering on the ProductId of an offer with list input.
Allows filtering on the ReleaseDate of an offer with date range as input.
Allows filtering on the ReleaseDate of offers after a date.
Allows filtering on the ReleaseDate of offers before a date.
Allows filtering on the ReleaseDate of an offer.
Allows filtering on the ReleaseDate of an offer with date range as input.
Allows filtering on the State of an offer.
Allows filtering on the State of an offer with list input.
Allows filtering on the Targeting of an offer.
Allows filtering on the Targeting of an offer with list input.
A filter for offers entity.
+ */ +export interface OfferFilters { + /** + * @public + *Allows filtering on EntityId of an offer.
Allows filtering on the Name of an offer.
Allows filtering on the ProductId of an offer.
Allows filtering on the ReleaseDate of an offer.
Allows filtering on the AvailabilityEndDate of an offer.
Allows filtering on the BuyerAccounts of an offer.
Allows filtering on the State of an offer.
Allows filtering on the Targeting of an offer.
Allows filtering on the LastModifiedDate of an offer.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization after a date.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization before a date.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date value as input.
Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.
Allows filtering on CreatedDate of a ResaleAuthorization after a date.
Allows filtering on CreatedDate of a ResaleAuthorization before a date.
Allows filtering on CreatedDate of a ResaleAuthorization.
Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.
Allows filtering on CreatedDate of a ResaleAuthorization with date value as input.
Allows filtering on EntityId of a ResaleAuthorization.
Allows filtering on EntityId of a ResaleAuthorization with list input.
Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.
Allows filtering on the LastModifiedDate of a ResaleAuthorization after a date.
Allows filtering on the LastModifiedDate of a ResaleAuthorization before a date.
Allows filtering on the LastModifiedDate of a ResaleAuthorization.
Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with list input.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with wild card input.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with list input.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with wild card input.
Allows filtering on the Name of a ResaleAuthorization.
Allows filtering on the Name of a ResaleAuthorization with list input.
Allows filtering on the Name of a ResaleAuthorization with wild card input.
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization with list input.
Allows filtering on the ProductId of a ResaleAuthorization.
Allows filtering on the ProductId of a ResaleAuthorization with list input.
Allows filtering on the ProductId of a ResaleAuthorization with wild card input.
Allows filtering on the ProductName of a ResaleAuthorization.
Allows filtering on the ProductName of a ResaleAuthorization with list input.
Allows filtering on the ProductName of a ResaleAuthorization with wild card input.
Allows filtering on the ResellerAccountID of a ResaleAuthorization.
Allows filtering on the ResellerAccountID of a ResaleAuthorization with list input.
Allows filtering on the ResellerAccountID of a ResaleAuthorization with wild card input.
Allows filtering on the ResellerLegalName of a ResaleAuthorization.
+ */ +export interface ResaleAuthorizationResellerLegalNameFilter { + /** + * @public + *Allows filtering on the ResellerLegalNameProductName of a ResaleAuthorization with list input.
+ */ + ValueList?: string[]; + + /** + * @public + *Allows filtering on the ResellerLegalName of a ResaleAuthorization with wild card input.
+ */ + WildCardValue?: string; +} + +/** + * @public + * @enum + */ +export const ResaleAuthorizationStatusString = { + Active: "Active", + Draft: "Draft", + Restricted: "Restricted", +} as const; + +/** + * @public + */ +export type ResaleAuthorizationStatusString = + (typeof ResaleAuthorizationStatusString)[keyof typeof ResaleAuthorizationStatusString]; + +/** + * @public + *Allows filtering on the Status of a ResaleAuthorization.
Allows filtering on the Status of a ResaleAuthorization with list input.
A filter for ResaleAuthorization entity.
+ */ +export interface ResaleAuthorizationFilters { + /** + * @public + *Allows filtering on the EntityId of a ResaleAuthorization.
Allows filtering on the Name of a ResaleAuthorization.
Allows filtering on the ProductId of a ResaleAuthorization.
Allows filtering on the CreatedDate of a ResaleAuthorization.
Allows filtering on the AvailabilityEndDate of a ResaleAuthorization.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.
Allows filtering on the ProductName of a ResaleAuthorization.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.
Allows filtering on the ResellerAccountID of a ResaleAuthorization.
Allows filtering on the ResellerLegalName of a ResaleAuthorization.
Allows filtering on the Status of a ResaleAuthorization.
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.
Allows filtering on the LastModifiedDate of a ResaleAuthorization.
Object that allows filtering on entity id of a SaaS product.
+ */ +export interface SaaSProductEntityIdFilter { + /** + * @public + *A string array of unique entity id values to be filtered on.
+ */ + ValueList?: string[]; +} + +/** + * @public + *Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Date after which the SaaS product was last modified.
+ */ + AfterValue?: string; + + /** + * @public + *Date before which the SaaS product was last modified.
+ */ + BeforeValue?: string; +} + +/** + * @public + *Object that allows filtering based on the last modified date of SaaS products
+ */ +export interface SaaSProductLastModifiedDateFilter { + /** + * @public + *Dates between which the SaaS product was last modified.
+ */ + DateRange?: SaaSProductLastModifiedDateFilterDateRange; +} + +/** + * @public + *Object that allows filtering on product title.
+ */ +export interface SaaSProductTitleFilter { + /** + * @public + *A string array of unique product title values to be filtered on.
+ */ + ValueList?: string[]; + + /** + * @public + *A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on the visibility of the product in the AWS Marketplace.
+ */ +export interface SaaSProductVisibilityFilter { + /** + * @public + *A string array of unique visibility values to be filtered on.
+ */ + ValueList?: SaaSProductVisibilityString[]; +} + +/** + * @public + *Object containing all the filter fields for SaaS products. Client can add a maximum of
+ * 8 filters in a single ListEntities request.
Unique identifier for the SaaS product.
+ */ + EntityId?: SaaSProductEntityIdFilter; + + /** + * @public + *The title of the SaaS product.
+ */ + ProductTitle?: SaaSProductTitleFilter; + + /** + * @public + *The visibility of the SaaS product.
+ */ + Visibility?: SaaSProductVisibilityFilter; + + /** + * @public + *The last date on which the SaaS product was modified.
+ */ + LastModifiedDate?: SaaSProductLastModifiedDateFilter; +} + +/** + * @public + *Object containing all the filter fields per entity type.
+ */ +export type EntityTypeFilters = + | EntityTypeFilters.AmiProductFiltersMember + | EntityTypeFilters.ContainerProductFiltersMember + | EntityTypeFilters.DataProductFiltersMember + | EntityTypeFilters.OfferFiltersMember + | EntityTypeFilters.ResaleAuthorizationFiltersMember + | EntityTypeFilters.SaaSProductFiltersMember + | EntityTypeFilters.$UnknownMember; + +/** + * @public + */ +export namespace EntityTypeFilters { + /** + * @public + *A filter for data products.
+ */ + export interface DataProductFiltersMember { + DataProductFilters: DataProductFilters; + SaaSProductFilters?: never; + AmiProductFilters?: never; + OfferFilters?: never; + ContainerProductFilters?: never; + ResaleAuthorizationFilters?: never; + $unknown?: never; + } + + /** + * @public + *A filter for SaaS products.
+ */ + export interface SaaSProductFiltersMember { + DataProductFilters?: never; + SaaSProductFilters: SaaSProductFilters; + AmiProductFilters?: never; + OfferFilters?: never; + ContainerProductFilters?: never; + ResaleAuthorizationFilters?: never; + $unknown?: never; + } + + /** + * @public + *A filter for AMI products.
+ */ + export interface AmiProductFiltersMember { + DataProductFilters?: never; + SaaSProductFilters?: never; + AmiProductFilters: AmiProductFilters; + OfferFilters?: never; + ContainerProductFilters?: never; + ResaleAuthorizationFilters?: never; + $unknown?: never; + } + + /** + * @public + *A filter for offers.
+ */ + export interface OfferFiltersMember { + DataProductFilters?: never; + SaaSProductFilters?: never; + AmiProductFilters?: never; + OfferFilters: OfferFilters; + ContainerProductFilters?: never; + ResaleAuthorizationFilters?: never; + $unknown?: never; + } + + /** + * @public + *A filter for container products.
+ */ + export interface ContainerProductFiltersMember { + DataProductFilters?: never; + SaaSProductFilters?: never; + AmiProductFilters?: never; + OfferFilters?: never; + ContainerProductFilters: ContainerProductFilters; + ResaleAuthorizationFilters?: never; + $unknown?: never; + } + + /** + * @public + *A filter for Resale Authorizations.
+ */ + export interface ResaleAuthorizationFiltersMember { + DataProductFilters?: never; + SaaSProductFilters?: never; + AmiProductFilters?: never; + OfferFilters?: never; + ContainerProductFilters?: never; + ResaleAuthorizationFilters: ResaleAuthorizationFilters; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + DataProductFilters?: never; + SaaSProductFilters?: never; + AmiProductFilters?: never; + OfferFilters?: never; + ContainerProductFilters?: never; + ResaleAuthorizationFilters?: never; + $unknown: [string, any]; + } + + export interface VisitorObjects that allows sorting on container products based on certain fields and sorting order.
+ */ +export interface ContainerProductSort { + /** + * @public + *Field to sort the container products by.
+ */ + SortBy?: ContainerProductSortBy; + + /** + * @public + *The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Objects that allows sorting on data products based on certain fields and sorting order.
+ */ +export interface DataProductSort { + /** + * @public + *Field to sort the data products by.
+ */ + SortBy?: DataProductSortBy; + + /** + * @public + *The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Allows to sort offers.
+ */ +export interface OfferSort { + /** + * @public + *Allows to sort offers.
+ */ + SortBy?: OfferSortBy; + + /** + * @public + *Allows to sort offers.
+ */ + SortOrder?: SortOrder; +} + +/** + * @public + * @enum + */ +export const ResaleAuthorizationSortBy = { + AvailabilityEndDate: "AvailabilityEndDate", + CreatedDate: "CreatedDate", + EntityId: "EntityId", + LastModifiedDate: "LastModifiedDate", + ManufacturerAccountId: "ManufacturerAccountId", + ManufacturerLegalName: "ManufacturerLegalName", + Name: "Name", + OfferExtendedStatus: "OfferExtendedStatus", + ProductId: "ProductId", + ProductName: "ProductName", + ResellerAccountID: "ResellerAccountID", + ResellerLegalName: "ResellerLegalName", + Status: "Status", +} as const; + +/** + * @public + */ +export type ResaleAuthorizationSortBy = (typeof ResaleAuthorizationSortBy)[keyof typeof ResaleAuthorizationSortBy]; + +/** + * @public + *Allows to sort ResaleAuthorization.
+ */ +export interface ResaleAuthorizationSort { + /** + * @public + *Allows to sort ResaleAuthorization.
+ */ + SortBy?: ResaleAuthorizationSortBy; + + /** + * @public + *Allows to sort ResaleAuthorization.
+ */ + SortOrder?: SortOrder; +} + +/** + * @public + * @enum + */ +export const SaaSProductSortBy = { + EntityId: "EntityId", + LastModifiedDate: "LastModifiedDate", + ProductTitle: "ProductTitle", + Visibility: "Visibility", +} as const; + +/** + * @public + */ +export type SaaSProductSortBy = (typeof SaaSProductSortBy)[keyof typeof SaaSProductSortBy]; + +/** + * @public + *Objects that allows sorting on SaaS products based on certain fields and sorting order.
+ */ +export interface SaaSProductSort { + /** + * @public + *Field to sort the SaaS products by.
+ */ + SortBy?: SaaSProductSortBy; + + /** + * @public + *The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Object containing all the sort fields per entity type.
+ */ +export type EntityTypeSort = + | EntityTypeSort.AmiProductSortMember + | EntityTypeSort.ContainerProductSortMember + | EntityTypeSort.DataProductSortMember + | EntityTypeSort.OfferSortMember + | EntityTypeSort.ResaleAuthorizationSortMember + | EntityTypeSort.SaaSProductSortMember + | EntityTypeSort.$UnknownMember; + +/** + * @public + */ +export namespace EntityTypeSort { + /** + * @public + *A sort for data products.
+ */ + export interface DataProductSortMember { + DataProductSort: DataProductSort; + SaaSProductSort?: never; + AmiProductSort?: never; + OfferSort?: never; + ContainerProductSort?: never; + ResaleAuthorizationSort?: never; + $unknown?: never; + } + + /** + * @public + *A sort for SaaS products.
+ */ + export interface SaaSProductSortMember { + DataProductSort?: never; + SaaSProductSort: SaaSProductSort; + AmiProductSort?: never; + OfferSort?: never; + ContainerProductSort?: never; + ResaleAuthorizationSort?: never; + $unknown?: never; + } + + /** + * @public + *A sort for AMI products.
+ */ + export interface AmiProductSortMember { + DataProductSort?: never; + SaaSProductSort?: never; + AmiProductSort: AmiProductSort; + OfferSort?: never; + ContainerProductSort?: never; + ResaleAuthorizationSort?: never; + $unknown?: never; + } + + /** + * @public + *A sort for offers.
+ */ + export interface OfferSortMember { + DataProductSort?: never; + SaaSProductSort?: never; + AmiProductSort?: never; + OfferSort: OfferSort; + ContainerProductSort?: never; + ResaleAuthorizationSort?: never; + $unknown?: never; + } + + /** + * @public + *A sort for container products.
+ */ + export interface ContainerProductSortMember { + DataProductSort?: never; + SaaSProductSort?: never; + AmiProductSort?: never; + OfferSort?: never; + ContainerProductSort: ContainerProductSort; + ResaleAuthorizationSort?: never; + $unknown?: never; + } + + /** + * @public + *A sort for Resale Authorizations.
+ */ + export interface ResaleAuthorizationSortMember { + DataProductSort?: never; + SaaSProductSort?: never; + AmiProductSort?: never; + OfferSort?: never; + ContainerProductSort?: never; + ResaleAuthorizationSort: ResaleAuthorizationSort; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + DataProductSort?: never; + SaaSProductSort?: never; + AmiProductSort?: never; + OfferSort?: never; + ContainerProductSort?: never; + ResaleAuthorizationSort?: never; + $unknown: [string, any]; + } + + export interface VisitorThe catalog related to the request. Fixed value: AWSMarketplace
+ *
The type of entities to
+ * retrieve. Valid
+ * values are: ServerProduct, AmiProduct,
+ * ContainerProduct, DataProduct, SaaSProduct,
+ * ProcurementPolicy, Experience, Audience,
+ * BrandingSettings, Offer, Seller,
+ * ResaleAuthorization.
An array of filter objects. Each filter object contains two attributes,
+ * filterName and filterValues.
An object that contains two attributes, SortBy and
+ * SortOrder.
The value of the next token, if it exists. Null if there are no more results.
+ */ + NextToken?: string; + + /** + * @public + *Specifies the upper limit of the elements on a single page. If a value isn't provided, + * the default value is 20.
+ */ + MaxResults?: number; + + /** + * @public + *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.
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.
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.
Object that contains summarized information about a container product.
+ */ +export interface ContainerProductSummary { + /** + * @public + *The title of the container product.
+ */ + ProductTitle?: string; + + /** + * @public + *The lifecycle of the product.
+ */ + Visibility?: ContainerProductVisibilityString; +} + +/** + * @public + *Object that contains summarized information about a data product.
+ */ +export interface DataProductSummary { + /** + * @public + *The title of the data product.
+ */ + ProductTitle?: string; + + /** + * @public + *The lifecycle of the data product.
+ */ + Visibility?: DataProductVisibilityString; +} + +/** + * @public + *Summarized information about an offer.
+ */ +export interface OfferSummary { + /** + * @public + *The name of the offer.
+ */ + Name?: string; + + /** + * @public + *The product ID of the offer.
+ */ + ProductId?: string; + + /** + * @public + *The release date of the offer.
+ */ + ReleaseDate?: string; + + /** + * @public + *The availability end date of the offer.
+ */ + AvailabilityEndDate?: string; + + /** + * @public + *The buyer accounts in the offer.
+ */ + BuyerAccounts?: string[]; + + /** + * @public + *The status of the offer.
+ */ + State?: OfferStateString; + + /** + * @public + *The targeting in the offer.
+ */ + Targeting?: OfferTargetingString[]; +} + +/** + * @public + *Summarized information about a Resale Authorization.
+ */ +export interface ResaleAuthorizationSummary { + /** + * @public + *The name of the ResaleAuthorization.
+ */ + Name?: string; + + /** + * @public + *The product ID of the ResaleAuthorization.
+ */ + ProductId?: string; + + /** + * @public + *The product name of the ResaleAuthorization.
+ */ + ProductName?: string; + + /** + * @public + *The manufacturer account ID of the ResaleAuthorization.
+ */ + ManufacturerAccountId?: string; + + /** + * @public + *The manufacturer legal name of the ResaleAuthorization.
+ */ + ManufacturerLegalName?: string; + + /** + * @public + *The reseller account ID of the ResaleAuthorization.
+ */ + ResellerAccountID?: string; + + /** + * @public + *The reseller legal name of the ResaleAuthorization
+ */ + ResellerLegalName?: string; + + /** + * @public + *The status of the ResaleAuthorization.
+ */ + Status?: ResaleAuthorizationStatusString; + + /** + * @public + *The offer extended status of the ResaleAuthorization
+ */ + OfferExtendedStatus?: string; + + /** + * @public + *The created date of the ResaleAuthorization.
+ */ + CreatedDate?: string; + + /** + * @public + *The availability end date of the ResaleAuthorization.
+ */ + AvailabilityEndDate?: string; +} + +/** + * @public + *Object that contains summarized information about a SaaS product.
+ */ +export interface SaaSProductSummary { + /** + * @public + *The title of the SaaS product.
+ */ + ProductTitle?: string; + + /** + * @public + *The lifecycle of the SaaS product.
+ */ + Visibility?: SaaSProductVisibilityString; +} + +/** + * @public + *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.
+ */ +export interface EntitySummary { + /** + * @public + *The name for the entity. This value is not unique. It is defined by the seller.
+ */ + Name?: string; + + /** + * @public + *The type of the entity.
+ */ + EntityType?: string; + + /** + * @public + *The unique identifier for the entity.
+ */ + EntityId?: string; + + /** + * @public + *The ARN associated with the unique identifier for the entity.
+ */ + EntityArn?: string; + + /** + * @public + *The last time the entity was published, using ISO 8601 format + * (2018-02-27T13:45:22Z).
+ */ + LastModifiedDate?: string; + + /** + * @public + *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).
An object that contains summary information about the AMI product.
+ */ + AmiProductSummary?: AmiProductSummary; + + /** + * @public + *An object that contains summary information about the container product.
+ */ + ContainerProductSummary?: ContainerProductSummary; + + /** + * @public + *An object that contains summary information about the data product.
+ */ + DataProductSummary?: DataProductSummary; + + /** + * @public + *An object that contains summary information about the SaaS product.
+ */ + SaaSProductSummary?: SaaSProductSummary; + + /** + * @public + *An object that contains summary information about the offer.
+ */ + OfferSummary?: OfferSummary; + + /** + * @public + *An object that contains summary information about the Resale Authorization.
+ */ + ResaleAuthorizationSummary?: ResaleAuthorizationSummary; } /** @@ -847,7 +2689,7 @@ export interface EntitySummary { export interface ListEntitiesResponse { /** * @public - * Array of EntitySummary object.
Array of EntitySummary objects.
A string array of unique entity id values to be filtered on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering on entity id of an AMI product.
" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductEntityIdFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#AmiProductEntityIdString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#AmiProductEntityIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductFilters": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.marketplacecatalog#AmiProductEntityIdFilter", + "traits": { + "smithy.api#documentation": "Unique identifier for the AMI product.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#AmiProductLastModifiedDateFilter", + "traits": { + "smithy.api#documentation": "The last date on which the AMI product was modified.
" + } + }, + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#AmiProductTitleFilter", + "traits": { + "smithy.api#documentation": "The title of the AMI product.
" + } + }, + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#AmiProductVisibilityFilter", + "traits": { + "smithy.api#documentation": "The visibility of the AMI product.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object containing all the filter fields for AMI products. Client can add a maximum of 8\n filters in a single ListEntities request.
Dates between which the AMI product was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering based on the last modified date of AMI products.
" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductLastModifiedDateFilterDateRange": { + "type": "structure", + "members": { + "AfterValue": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "Date after which the AMI product was last modified.
" + } + }, + "BeforeValue": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "Date before which the AMI product was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Field to sort the AMI products by.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.marketplacecatalog#SortOrder", + "traits": { + "smithy.api#documentation": "The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Objects that allows sorting on AMI products based on certain fields and sorting order.
" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductSortBy": { + "type": "enum", + "members": { + "EntityId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntityId" + } + }, + "LastModifiedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedDate" + } + }, + "ProductTitle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductTitle" + } + }, + "Visibility": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Visibility" + } + } + } + }, + "com.amazonaws.marketplacecatalog#AmiProductSummary": { + "type": "structure", + "members": { + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#AmiProductTitleString", + "traits": { + "smithy.api#documentation": "The title of the AMI product.
" + } + }, + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#AmiProductVisibilityString", + "traits": { + "smithy.api#documentation": "The lifecycle of the AMI product.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that contains summarized information about an AMI product.
" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductTitleFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#AmiProductTitleFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique product title values to be filtered on.
" + } + }, + "WildCardValue": { + "target": "com.amazonaws.marketplacecatalog#AmiProductTitleString", + "traits": { + "smithy.api#documentation": "A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on product title.
" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductTitleFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#AmiProductTitleString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#AmiProductTitleString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(.)+$" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductVisibilityFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#AmiProductVisibilityFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique visibility values to be filtered on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" + } + }, + "com.amazonaws.marketplacecatalog#AmiProductVisibilityFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#AmiProductVisibilityString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#AmiProductVisibilityString": { + "type": "enum", + "members": { + "Limited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Limited" + } + }, + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Public" + } + }, + "Restricted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restricted" + } + }, + "Draft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Draft" + } + } + } + }, "com.amazonaws.marketplacecatalog#CancelChangeSet": { "type": "operation", "input": { @@ -1061,511 +1329,565 @@ "smithy.api#pattern": "^[!-~]+$" } }, - "com.amazonaws.marketplacecatalog#DateTimeISO8601": { - "type": "string", + "com.amazonaws.marketplacecatalog#ContainerProductEntityIdFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductEntityIdFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique entity id values to be filtered on.
" + } + } + }, "traits": { - "smithy.api#length": { - "min": 20, - "max": 20 - }, - "smithy.api#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$" + "smithy.api#documentation": "Object that allows filtering on entity id of a container product.
" } }, - "com.amazonaws.marketplacecatalog#DeleteResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse" + "com.amazonaws.marketplacecatalog#ContainerProductEntityIdFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductEntityIdString" }, - "errors": [ - { - "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" - }, - { - "target": "com.amazonaws.marketplacecatalog#InternalServiceException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ThrottlingException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes a resource-based policy on an entity that is identified by its resource\n ARN.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteResourcePolicy", - "code": 200 + "smithy.api#length": { + "min": 1, + "max": 10 } } }, - "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest": { + "com.amazonaws.marketplacecatalog#ContainerProductEntityIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" + } + }, + "com.amazonaws.marketplacecatalog#ContainerProductFilters": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "EntityId": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductEntityIdFilter", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity resource that is associated with the\n resource policy.
", - "smithy.api#httpQuery": "resourceArn", - "smithy.api#required": {} + "smithy.api#documentation": "Unique identifier for the container product.
" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.marketplacecatalog#DescribeChangeSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.marketplacecatalog#DescribeChangeSetRequest" - }, - "output": { - "target": "com.amazonaws.marketplacecatalog#DescribeChangeSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" - }, - { - "target": "com.amazonaws.marketplacecatalog#InternalServiceException" }, - { - "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductLastModifiedDateFilter", + "traits": { + "smithy.api#documentation": "The last date on which the container product was modified.
" + } }, - { - "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleFilter", + "traits": { + "smithy.api#documentation": "The title of the container product.
" + } }, - { - "target": "com.amazonaws.marketplacecatalog#ValidationException" + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilter", + "traits": { + "smithy.api#documentation": "The visibility of the container product.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Provides information about a given change set.
", - "smithy.api#http": { - "method": "GET", - "uri": "/DescribeChangeSet", - "code": 200 - } + "smithy.api#documentation": "Object containing all the filter fields for container products. Client can add a maximum of 8 filters in a single ListEntities request.
Required. The catalog related to the request. Fixed value:\n AWSMarketplace\n
Required. The unique identifier for the StartChangeSet request that you\n want to describe the details for.
Dates between which the container product was last modified.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Object that allows filtering based on the last modified date of container products.
" } }, - "com.amazonaws.marketplacecatalog#DescribeChangeSetResponse": { + "com.amazonaws.marketplacecatalog#ContainerProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { - "ChangeSetId": { - "target": "com.amazonaws.marketplacecatalog#ResourceId", - "traits": { - "smithy.api#documentation": "Required. The unique identifier for the change set referenced in this request.
" - } - }, - "ChangeSetArn": { - "target": "com.amazonaws.marketplacecatalog#ARN", - "traits": { - "smithy.api#documentation": "The ARN associated with the unique identifier for the change set referenced in this\n request.
" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.marketplacecatalog#ChangeSetName", - "traits": { - "smithy.api#documentation": "The optional name provided in the StartChangeSet request. If you do not\n provide a name, one is set by default.
The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.\n
" + "smithy.api#documentation": "Date after which the container product was last modified.
" } }, - "EndTime": { + "BeforeValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { - "smithy.api#documentation": "The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned\n to a terminal state. The change cannot transition to a different state. Null if the\n request is not in a terminal state.
" - } - }, - "Status": { - "target": "com.amazonaws.marketplacecatalog#ChangeStatus", - "traits": { - "smithy.api#documentation": "The status of the change request.
" - } - }, - "FailureCode": { - "target": "com.amazonaws.marketplacecatalog#FailureCode", - "traits": { - "smithy.api#documentation": "Returned if the change set is in FAILED status. Can be either\n CLIENT_ERROR, which means that there are issues with the request (see\n the ErrorDetailList), or SERVER_FAULT, which means that there\n is a problem in the system, and you should retry your request.
Returned if there is a failure on the change set, but that failure is not related to\n any of the changes in the request.
" - } - }, - "ChangeSet": { - "target": "com.amazonaws.marketplacecatalog#ChangeSetDescription", - "traits": { - "smithy.api#documentation": "An array of ChangeSummary objects.
Date before which the container product was last modified.
" } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.marketplacecatalog#DescribeEntity": { - "type": "operation", - "input": { - "target": "com.amazonaws.marketplacecatalog#DescribeEntityRequest" - }, - "output": { - "target": "com.amazonaws.marketplacecatalog#DescribeEntityResponse" - }, - "errors": [ - { - "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" - }, - { - "target": "com.amazonaws.marketplacecatalog#InternalServiceException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ResourceNotSupportedException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ThrottlingException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the metadata and content of the entity.
", - "smithy.api#http": { - "method": "GET", - "uri": "/DescribeEntity", - "code": 200 - } + "smithy.api#documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Required. The catalog related to the request. Fixed value:\n AWSMarketplace\n
Field to sort the container products by.
" } }, - "EntityId": { - "target": "com.amazonaws.marketplacecatalog#ResourceId", + "SortOrder": { + "target": "com.amazonaws.marketplacecatalog#SortOrder", "traits": { - "smithy.api#documentation": "Required. The unique ID of the entity to describe.
", - "smithy.api#httpQuery": "entityId", - "smithy.api#required": {} + "smithy.api#documentation": "The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Objects that allows sorting on container products based on certain fields and sorting order.
" } }, - "com.amazonaws.marketplacecatalog#DescribeEntityResponse": { - "type": "structure", + "com.amazonaws.marketplacecatalog#ContainerProductSortBy": { + "type": "enum", "members": { - "EntityType": { - "target": "com.amazonaws.marketplacecatalog#EntityType", + "EntityId": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The named type of the entity, in the format of EntityType@Version.
The identifier of the entity, in the format of\n EntityId@RevisionId.
The ARN associated to the unique identifier for the entity referenced in this\n request.
" + "smithy.api#enumValue": "ProductTitle" } }, - "LastModifiedDate": { - "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "Visibility": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The last modified date of the entity, in ISO 8601 format\n (2018-02-27T13:45:22Z).
" + "smithy.api#enumValue": "Visibility" } - }, - "Details": { - "target": "com.amazonaws.marketplacecatalog#Json", + } + } + }, + "com.amazonaws.marketplacecatalog#ContainerProductSummary": { + "type": "structure", + "members": { + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleString", "traits": { - "smithy.api#documentation": "This stringified JSON object includes the details of the entity.
" + "smithy.api#documentation": "The title of the container product.
" } }, - "DetailsDocument": { - "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityString", "traits": { - "smithy.api#documentation": "The JSON value of the details specific to the entity.
" + "smithy.api#documentation": "The lifecycle of the product.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Object that contains summarized information about a container product.
" } }, - "com.amazonaws.marketplacecatalog#Entity": { + "com.amazonaws.marketplacecatalog#ContainerProductTitleFilter": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.marketplacecatalog#EntityType", + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleFilterValueList", "traits": { - "smithy.api#documentation": "The type of entity.
", - "smithy.api#required": {} + "smithy.api#documentation": "A string array of unique product title values to be filtered on.
" } }, - "Identifier": { - "target": "com.amazonaws.marketplacecatalog#Identifier", + "WildCardValue": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleString", "traits": { - "smithy.api#documentation": "The identifier for the entity.
" + "smithy.api#documentation": "A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
An entity contains data that describes your product, its supported features, and how\n it can be used or launched by your customer.
" + "smithy.api#documentation": "Object that allows filtering on product title.
" } }, - "com.amazonaws.marketplacecatalog#EntityNameString": { + "com.amazonaws.marketplacecatalog#ContainerProductTitleFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#ContainerProductTitleString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, - "smithy.api#pattern": "^\\\\S+[\\\\S\\\\s]*$" + "smithy.api#pattern": "^(.)+$" } }, - "com.amazonaws.marketplacecatalog#EntitySummary": { + "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.marketplacecatalog#EntityNameString", + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilterValueList", "traits": { - "smithy.api#documentation": "The name for the entity. This value is not unique. It is defined by the seller.
" + "smithy.api#documentation": "A string array of unique visibility values to be filtered on.
" } - }, - "EntityType": { - "target": "com.amazonaws.marketplacecatalog#EntityType", + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" + } + }, + "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#ContainerProductVisibilityString": { + "type": "enum", + "members": { + "Limited": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The type of the entity.
" + "smithy.api#enumValue": "Limited" } }, - "EntityId": { - "target": "com.amazonaws.marketplacecatalog#ResourceId", + "Public": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier for the entity.
" + "smithy.api#enumValue": "Public" } }, - "EntityArn": { - "target": "com.amazonaws.marketplacecatalog#ARN", + "Restricted": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ARN associated with the unique identifier for the entity.
" + "smithy.api#enumValue": "Restricted" } }, - "LastModifiedDate": { - "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "Draft": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The last time the entity was published, using ISO 8601 format\n (2018-02-27T13:45:22Z).
" + "smithy.api#enumValue": "Draft" } - }, - "Visibility": { - "target": "com.amazonaws.marketplacecatalog#VisibilityValue", + } + } + }, + "com.amazonaws.marketplacecatalog#DataProductEntityIdFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#DataProductEntityIdFilterValueList", "traits": { - "smithy.api#documentation": "The visibility status of the entity to buyers. This value can be Public\n (everyone can view the entity), Limited (the entity is visible to limited\n accounts only), or Restricted (the entity was published and then\n unpublished and only existing buyers can view it).
A string array of unique entity id values to be filtered on.
" } } }, "traits": { - "smithy.api#documentation": "This object is a container for common summary information about the entity. The\n summary doesn't contain the whole entity structure, but it does contain information\n common across all entities.
" + "smithy.api#documentation": "Object that allows filtering on entity id of a data product.
" } }, - "com.amazonaws.marketplacecatalog#EntitySummaryList": { + "com.amazonaws.marketplacecatalog#DataProductEntityIdFilterValueList": { "type": "list", "member": { - "target": "com.amazonaws.marketplacecatalog#EntitySummary" - } - }, - "com.amazonaws.marketplacecatalog#EntityType": { - "type": "string", + "target": "com.amazonaws.marketplacecatalog#DataProductEntityIdString" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z]+$" + "max": 10 + } } }, - "com.amazonaws.marketplacecatalog#ErrorCodeString": { + "com.amazonaws.marketplacecatalog#DataProductEntityIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 72 + "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z_]+$" + "smithy.api#pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" } }, - "com.amazonaws.marketplacecatalog#ErrorDetail": { + "com.amazonaws.marketplacecatalog#DataProductFilters": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.marketplacecatalog#ErrorCodeString", + "EntityId": { + "target": "com.amazonaws.marketplacecatalog#DataProductEntityIdFilter", "traits": { - "smithy.api#documentation": "The error code that identifies the type of error.
" + "smithy.api#documentation": "Unique identifier for the data product.
" } }, - "ErrorMessage": { - "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent", + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#DataProductTitleFilter", "traits": { - "smithy.api#documentation": "The message for the error.
" + "smithy.api#documentation": "The title of the data product.
" + } + }, + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#DataProductVisibilityFilter", + "traits": { + "smithy.api#documentation": "The visibility of the data product.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#DataProductLastModifiedDateFilter", + "traits": { + "smithy.api#documentation": "The last date on which the data product was modified.
" } } }, "traits": { - "smithy.api#documentation": "Details about the error.
" + "smithy.api#documentation": "Object containing all the filter fields for data products. Client can add a maximum of 8 filters in a single ListEntities request.
Dates between which the data product was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering based on the last modified date of data products.
" } }, - "com.amazonaws.marketplacecatalog#ExceptionMessageContent": { - "type": "string", + "com.amazonaws.marketplacecatalog#DataProductLastModifiedDateFilterDateRange": { + "type": "structure", + "members": { + "AfterValue": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "Date after which the data product was last modified.
" + } + }, + "BeforeValue": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "Date before which the data product was last modified.
" + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 + "smithy.api#documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Field to sort the data products by.
" + } }, - "smithy.api#pattern": "^(.)+$" + "SortOrder": { + "target": "com.amazonaws.marketplacecatalog#SortOrder", + "traits": { + "smithy.api#documentation": "The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Objects that allows sorting on data products based on certain fields and sorting order.
" } }, - "com.amazonaws.marketplacecatalog#FailureCode": { + "com.amazonaws.marketplacecatalog#DataProductSortBy": { "type": "enum", "members": { - "ClientError": { + "EntityId": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CLIENT_ERROR" + "smithy.api#enumValue": "EntityId" } }, - "ServerFault": { + "ProductTitle": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SERVER_FAULT" + "smithy.api#enumValue": "ProductTitle" + } + }, + "Visibility": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Visibility" + } + }, + "LastModifiedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedDate" } } } }, - "com.amazonaws.marketplacecatalog#Filter": { + "com.amazonaws.marketplacecatalog#DataProductSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.marketplacecatalog#FilterName", + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#DataProductTitleString", "traits": { - "smithy.api#documentation": "For ListEntities, the supported value for this is an\n EntityId.
For ListChangeSets, the supported values are as follows:
The title of the data product.
" } }, + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#DataProductVisibilityString", + "traits": { + "smithy.api#documentation": "The lifecycle of the data product.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that contains summarized information about a data product.
" + } + }, + "com.amazonaws.marketplacecatalog#DataProductTitleFilter": { + "type": "structure", + "members": { "ValueList": { - "target": "com.amazonaws.marketplacecatalog#ValueList", + "target": "com.amazonaws.marketplacecatalog#DataProductTitleFilterValueList", "traits": { - "smithy.api#documentation": "\n ListEntities - This is a list of unique EntityIds.
\n ListChangeSets - The supported filter names and associated\n ValueLists is as follows:
\n ChangeSetName - The supported ValueList is a list of\n non-unique ChangeSetNames. These are defined when you call the\n StartChangeSet action.
\n Status - The supported ValueList is a list of\n statuses for all change set requests.
\n EntityId - The supported ValueList is a list of\n unique EntityIds.
\n BeforeStartTime - The supported ValueList is a list\n of all change sets that started before the filter value.
\n AfterStartTime - The supported ValueList is a list\n of all change sets that started after the filter value.
\n BeforeEndTime - The supported ValueList is a list of\n all change sets that ended before the filter value.
\n AfterEndTime - The supported ValueList is a list of\n all change sets that ended after the filter value.
A string array of unique product title values to be filtered on.
" + } + }, + "WildCardValue": { + "target": "com.amazonaws.marketplacecatalog#DataProductTitleString", + "traits": { + "smithy.api#documentation": "A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
A filter object, used to optionally filter results from calls to the\n ListEntities and ListChangeSets actions.
Object that allows filtering on product title.
" } }, - "com.amazonaws.marketplacecatalog#FilterList": { + "com.amazonaws.marketplacecatalog#DataProductTitleFilterValueList": { "type": "list", "member": { - "target": "com.amazonaws.marketplacecatalog#Filter" + "target": "com.amazonaws.marketplacecatalog#DataProductTitleString" }, "traits": { "smithy.api#length": { "min": 1, - "max": 8 + "max": 10 } } }, - "com.amazonaws.marketplacecatalog#FilterName": { + "com.amazonaws.marketplacecatalog#DataProductTitleString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z]+$" + "smithy.api#pattern": "^(.)+$" } }, - "com.amazonaws.marketplacecatalog#FilterValueContent": { - "type": "string", + "com.amazonaws.marketplacecatalog#DataProductVisibilityFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#DataProductVisibilityFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique visibility values to be filtered on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" + } + }, + "com.amazonaws.marketplacecatalog#DataProductVisibilityFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#DataProductVisibilityString" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 255 + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#DataProductVisibilityString": { + "type": "enum", + "members": { + "Limited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Limited" + } }, - "smithy.api#pattern": "^(.)+$" + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Public" + } + }, + "Restricted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restricted" + } + }, + "Unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unavailable" + } + }, + "Draft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Draft" + } + } } }, - "com.amazonaws.marketplacecatalog#GetResourcePolicy": { + "com.amazonaws.marketplacecatalog#DateTimeISO8601": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 20 + }, + "smithy.api#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$" + } + }, + "com.amazonaws.marketplacecatalog#DeleteResourcePolicy": { "type": "operation", "input": { - "target": "com.amazonaws.marketplacecatalog#GetResourcePolicyRequest" + "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest" }, "output": { - "target": "com.amazonaws.marketplacecatalog#GetResourcePolicyResponse" + "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse" }, "errors": [ { @@ -1585,15 +1907,15 @@ } ], "traits": { - "smithy.api#documentation": "Gets a resource-based policy of an entity that is identified by its resource\n ARN.
", + "smithy.api#documentation": "Deletes a resource-based policy on an entity that is identified by its resource\n ARN.
", "smithy.api#http": { - "method": "GET", - "uri": "/GetResourcePolicy", + "method": "DELETE", + "uri": "/DeleteResourcePolicy", "code": 200 } } }, - "com.amazonaws.marketplacecatalog#GetResourcePolicyRequest": { + "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { @@ -1609,63 +1931,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.marketplacecatalog#GetResourcePolicyResponse": { + "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse": { "type": "structure", - "members": { - "Policy": { - "target": "com.amazonaws.marketplacecatalog#ResourcePolicyJson", - "traits": { - "smithy.api#documentation": "The policy document to set; formatted in JSON.
" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.marketplacecatalog#Identifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w\\-@]+$" - } - }, - "com.amazonaws.marketplacecatalog#InternalServiceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" - } - }, - "traits": { - "smithy.api#documentation": "There was an internal service exception.
\nHTTP status code: 500
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.marketplacecatalog#Json": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 16384 - }, - "smithy.api#pattern": "^[\\s]*\\{[\\s\\S]*\\}[\\s]*$" - } - }, - "com.amazonaws.marketplacecatalog#JsonDocumentType": { - "type": "document" - }, - "com.amazonaws.marketplacecatalog#ListChangeSets": { + "com.amazonaws.marketplacecatalog#DescribeChangeSet": { "type": "operation", "input": { - "target": "com.amazonaws.marketplacecatalog#ListChangeSetsRequest" + "target": "com.amazonaws.marketplacecatalog#DescribeChangeSetRequest" }, "output": { - "target": "com.amazonaws.marketplacecatalog#ListChangeSetsResponse" + "target": "com.amazonaws.marketplacecatalog#DescribeChangeSetResponse" }, "errors": [ { @@ -1674,6 +1953,9 @@ { "target": "com.amazonaws.marketplacecatalog#InternalServiceException" }, + { + "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" + }, { "target": "com.amazonaws.marketplacecatalog#ThrottlingException" }, @@ -1682,81 +1964,93 @@ } ], "traits": { - "smithy.api#documentation": "Returns the list of change sets owned by the account being used to make the call. You\n can filter this list by providing any combination of entityId,\n ChangeSetName, and status. If you provide more than one filter, the API\n operation applies a logical AND between the filters.
You can describe a change during the 60-day request history retention period for API\n calls.
", + "smithy.api#documentation": "Provides information about a given change set.
", "smithy.api#http": { - "method": "POST", - "uri": "/ListChangeSets", + "method": "GET", + "uri": "/DescribeChangeSet", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ChangeSetSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.marketplacecatalog#ListChangeSetsMaxResultInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 } } }, - "com.amazonaws.marketplacecatalog#ListChangeSetsRequest": { + "com.amazonaws.marketplacecatalog#DescribeChangeSetRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.marketplacecatalog#Catalog", "traits": { - "smithy.api#documentation": "The catalog related to the request. Fixed value: AWSMarketplace\n
Required. The catalog related to the request. Fixed value:\n AWSMarketplace\n
An array of filter objects.
" + "smithy.api#documentation": "Required. The unique identifier for the StartChangeSet request that you\n want to describe the details for.
Required. The unique identifier for the change set referenced in this request.
" } }, - "Sort": { - "target": "com.amazonaws.marketplacecatalog#Sort", + "ChangeSetArn": { + "target": "com.amazonaws.marketplacecatalog#ARN", "traits": { - "smithy.api#documentation": "An object that contains two attributes, SortBy and\n SortOrder.
The ARN associated with the unique identifier for the change set referenced in this\n request.
" } }, - "MaxResults": { - "target": "com.amazonaws.marketplacecatalog#ListChangeSetsMaxResultInteger", + "ChangeSetName": { + "target": "com.amazonaws.marketplacecatalog#ChangeSetName", "traits": { - "smithy.api#documentation": "The maximum number of results returned by a single call. This value must be provided\n in the next call to retrieve the next set of results. By default, this value is\n 20.
" + "smithy.api#documentation": "The optional name provided in the StartChangeSet request. If you do not\n provide a name, one is set by default.
The token value retrieved from a previous call to access the next page of\n results.
" + "smithy.api#documentation": "The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.\n
" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.marketplacecatalog#ListChangeSetsResponse": { - "type": "structure", - "members": { - "ChangeSetSummaryList": { - "target": "com.amazonaws.marketplacecatalog#ChangeSetSummaryList", + }, + "EndTime": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { - "smithy.api#documentation": " Array of ChangeSetSummaryListItem objects.
The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned\n to a terminal state. The change cannot transition to a different state. Null if the\n request is not in a terminal state.
" } }, - "NextToken": { - "target": "com.amazonaws.marketplacecatalog#NextToken", + "Status": { + "target": "com.amazonaws.marketplacecatalog#ChangeStatus", "traits": { - "smithy.api#documentation": "The value of the next token, if it exists. Null if there are no more results.
" + "smithy.api#documentation": "The status of the change request.
" + } + }, + "FailureCode": { + "target": "com.amazonaws.marketplacecatalog#FailureCode", + "traits": { + "smithy.api#documentation": "Returned if the change set is in FAILED status. Can be either\n CLIENT_ERROR, which means that there are issues with the request (see\n the ErrorDetailList), or SERVER_FAULT, which means that there\n is a problem in the system, and you should retry your request.
Returned if there is a failure on the change set, but that failure is not related to\n any of the changes in the request.
" + } + }, + "ChangeSet": { + "target": "com.amazonaws.marketplacecatalog#ChangeSetDescription", + "traits": { + "smithy.api#documentation": "An array of ChangeSummary objects.
Provides the list of entities of a given type.
", + "smithy.api#documentation": "Returns the metadata and content of the entity.
", "smithy.api#http": { - "method": "POST", - "uri": "/ListEntities", + "method": "GET", + "uri": "/DescribeEntity", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EntitySummaryList", - "pageSize": "MaxResults" } } }, - "com.amazonaws.marketplacecatalog#ListEntitiesMaxResultInteger": { - "type": "integer", + "com.amazonaws.marketplacecatalog#DescribeEntityRequest": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.marketplacecatalog#Catalog", + "traits": { + "smithy.api#documentation": "Required. The catalog related to the request. Fixed value:\n AWSMarketplace\n
Required. The unique ID of the entity to describe.
", + "smithy.api#httpQuery": "entityId", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#DescribeEntityResponse": { + "type": "structure", + "members": { + "EntityType": { + "target": "com.amazonaws.marketplacecatalog#EntityType", + "traits": { + "smithy.api#documentation": "The named type of the entity, in the format of EntityType@Version.
The identifier of the entity, in the format of\n EntityId@RevisionId.
The ARN associated to the unique identifier for the entity referenced in this\n request.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "The last modified date of the entity, in ISO 8601 format\n (2018-02-27T13:45:22Z).
" + } + }, + "Details": { + "target": "com.amazonaws.marketplacecatalog#Json", + "traits": { + "smithy.api#documentation": "This stringified JSON object includes the details of the entity.
" + } + }, + "DetailsDocument": { + "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", + "traits": { + "smithy.api#documentation": "The JSON value of the details specific to the entity.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.marketplacecatalog#ListEntitiesRequest": { + "com.amazonaws.marketplacecatalog#Entity": { "type": "structure", "members": { - "Catalog": { - "target": "com.amazonaws.marketplacecatalog#Catalog", + "Type": { + "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { - "smithy.api#documentation": "The catalog related to the request. Fixed value: AWSMarketplace\n
The type of entity.
", "smithy.api#required": {} } }, + "Identifier": { + "target": "com.amazonaws.marketplacecatalog#Identifier", + "traits": { + "smithy.api#documentation": "The identifier for the entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An entity contains data that describes your product, its supported features, and how\n it can be used or launched by your customer.
" + } + }, + "com.amazonaws.marketplacecatalog#EntityNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^\\\\S+[\\\\S\\\\s]*$" + } + }, + "com.amazonaws.marketplacecatalog#EntitySummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.marketplacecatalog#EntityNameString", + "traits": { + "smithy.api#documentation": "The name for the entity. This value is not unique. It is defined by the seller.
" + } + }, "EntityType": { "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { - "smithy.api#documentation": "The type of entities to retrieve.
", - "smithy.api#required": {} + "smithy.api#documentation": "The type of the entity.
" } }, - "FilterList": { - "target": "com.amazonaws.marketplacecatalog#FilterList", + "EntityId": { + "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { - "smithy.api#documentation": "An array of filter objects. Each filter object contains two attributes,\n filterName and filterValues.
The unique identifier for the entity.
" + } + }, + "EntityArn": { + "target": "com.amazonaws.marketplacecatalog#ARN", + "traits": { + "smithy.api#documentation": "The ARN associated with the unique identifier for the entity.
" } }, - "Sort": { - "target": "com.amazonaws.marketplacecatalog#Sort", + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "The last time the entity was published, using ISO 8601 format\n (2018-02-27T13:45:22Z).
" + } + }, + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#VisibilityValue", + "traits": { + "smithy.api#documentation": "The visibility status of the entity to buyers. This value can be Public\n (everyone can view the entity), Limited (the entity is visible to limited\n accounts only), or Restricted (the entity was published and then\n unpublished and only existing buyers can view it).
An object that contains summary information about the AMI product.
" + } + }, + "ContainerProductSummary": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductSummary", + "traits": { + "smithy.api#documentation": "An object that contains summary information about the container product.
" + } + }, + "DataProductSummary": { + "target": "com.amazonaws.marketplacecatalog#DataProductSummary", + "traits": { + "smithy.api#documentation": "An object that contains summary information about the data product.
" + } + }, + "SaaSProductSummary": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductSummary", + "traits": { + "smithy.api#documentation": "An object that contains summary information about the SaaS product.
" + } + }, + "OfferSummary": { + "target": "com.amazonaws.marketplacecatalog#OfferSummary", + "traits": { + "smithy.api#documentation": "An object that contains summary information about the offer.
" + } + }, + "ResaleAuthorizationSummary": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationSummary", + "traits": { + "smithy.api#documentation": "An object that contains summary information about the Resale Authorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This object is a container for common summary information about the entity. The\n summary doesn't contain the whole entity structure, but it does contain information\n common across all entities.
" + } + }, + "com.amazonaws.marketplacecatalog#EntitySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#EntitySummary" + } + }, + "com.amazonaws.marketplacecatalog#EntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z]+$" + } + }, + "com.amazonaws.marketplacecatalog#EntityTypeFilters": { + "type": "union", + "members": { + "DataProductFilters": { + "target": "com.amazonaws.marketplacecatalog#DataProductFilters", + "traits": { + "smithy.api#documentation": "A filter for data products.
" + } + }, + "SaaSProductFilters": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductFilters", + "traits": { + "smithy.api#documentation": "A filter for SaaS products.
" + } + }, + "AmiProductFilters": { + "target": "com.amazonaws.marketplacecatalog#AmiProductFilters", + "traits": { + "smithy.api#documentation": "A filter for AMI products.
" + } + }, + "OfferFilters": { + "target": "com.amazonaws.marketplacecatalog#OfferFilters", + "traits": { + "smithy.api#documentation": "A filter for offers.
" + } + }, + "ContainerProductFilters": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductFilters", + "traits": { + "smithy.api#documentation": "A filter for container products.
" + } + }, + "ResaleAuthorizationFilters": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationFilters", + "traits": { + "smithy.api#documentation": "A filter for Resale Authorizations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object containing all the filter fields per entity type.
" + } + }, + "com.amazonaws.marketplacecatalog#EntityTypeSort": { + "type": "union", + "members": { + "DataProductSort": { + "target": "com.amazonaws.marketplacecatalog#DataProductSort", + "traits": { + "smithy.api#documentation": "A sort for data products.
" + } + }, + "SaaSProductSort": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductSort", + "traits": { + "smithy.api#documentation": "A sort for SaaS products.
" + } + }, + "AmiProductSort": { + "target": "com.amazonaws.marketplacecatalog#AmiProductSort", + "traits": { + "smithy.api#documentation": "A sort for AMI products.
" + } + }, + "OfferSort": { + "target": "com.amazonaws.marketplacecatalog#OfferSort", + "traits": { + "smithy.api#documentation": "A sort for offers.
" + } + }, + "ContainerProductSort": { + "target": "com.amazonaws.marketplacecatalog#ContainerProductSort", + "traits": { + "smithy.api#documentation": "A sort for container products.
" + } + }, + "ResaleAuthorizationSort": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationSort", + "traits": { + "smithy.api#documentation": "A sort for Resale Authorizations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object containing all the sort fields per entity type.
" + } + }, + "com.amazonaws.marketplacecatalog#ErrorCodeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 72 + }, + "smithy.api#pattern": "^[a-zA-Z_]+$" + } + }, + "com.amazonaws.marketplacecatalog#ErrorDetail": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.marketplacecatalog#ErrorCodeString", + "traits": { + "smithy.api#documentation": "The error code that identifies the type of error.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent", + "traits": { + "smithy.api#documentation": "The message for the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the error.
" + } + }, + "com.amazonaws.marketplacecatalog#ErrorDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#ErrorDetail" + } + }, + "com.amazonaws.marketplacecatalog#ExceptionMessageContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(.)+$" + } + }, + "com.amazonaws.marketplacecatalog#FailureCode": { + "type": "enum", + "members": { + "ClientError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_ERROR" + } + }, + "ServerFault": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_FAULT" + } + } + } + }, + "com.amazonaws.marketplacecatalog#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.marketplacecatalog#FilterName", + "traits": { + "smithy.api#documentation": "For ListEntities, the supported value for this is an\n EntityId.
For ListChangeSets, the supported values are as follows:
\n ListEntities - This is a list of unique EntityIds.
\n ListChangeSets - The supported filter names and associated\n ValueLists is as follows:
\n ChangeSetName - The supported ValueList is a list of\n non-unique ChangeSetNames. These are defined when you call the\n StartChangeSet action.
\n Status - The supported ValueList is a list of\n statuses for all change set requests.
\n EntityId - The supported ValueList is a list of\n unique EntityIds.
\n BeforeStartTime - The supported ValueList is a list\n of all change sets that started before the filter value.
\n AfterStartTime - The supported ValueList is a list\n of all change sets that started after the filter value.
\n BeforeEndTime - The supported ValueList is a list of\n all change sets that ended before the filter value.
\n AfterEndTime - The supported ValueList is a list of\n all change sets that ended after the filter value.
A filter object, used to optionally filter results from calls to the\n ListEntities and ListChangeSets actions.
Gets a resource-based policy of an entity that is identified by its resource\n ARN.
", + "smithy.api#http": { + "method": "GET", + "uri": "/GetResourcePolicy", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity resource that is associated with the\n resource policy.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.marketplacecatalog#ResourcePolicyJson", + "traits": { + "smithy.api#documentation": "The policy document to set; formatted in JSON.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.marketplacecatalog#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w\\-@]+$" + } + }, + "com.amazonaws.marketplacecatalog#InternalServiceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" + } + }, + "traits": { + "smithy.api#documentation": "There was an internal service exception.
\nHTTP status code: 500
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.marketplacecatalog#Json": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 16384 + }, + "smithy.api#pattern": "^[\\s]*\\{[\\s\\S]*\\}[\\s]*$" + } + }, + "com.amazonaws.marketplacecatalog#JsonDocumentType": { + "type": "document" + }, + "com.amazonaws.marketplacecatalog#ListChangeSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#ListChangeSetsRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#ListChangeSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.marketplacecatalog#InternalServiceException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the list of change sets owned by the account being used to make the call. You\n can filter this list by providing any combination of entityId,\n ChangeSetName, and status. If you provide more than one filter, the API\n operation applies a logical AND between the filters.
You can describe a change during the 60-day request history retention period for API\n calls.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListChangeSets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ChangeSetSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.marketplacecatalog#ListChangeSetsMaxResultInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.marketplacecatalog#ListChangeSetsRequest": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.marketplacecatalog#Catalog", + "traits": { + "smithy.api#documentation": "The catalog related to the request. Fixed value: AWSMarketplace\n
An array of filter objects.
" + } + }, + "Sort": { + "target": "com.amazonaws.marketplacecatalog#Sort", + "traits": { + "smithy.api#documentation": "An object that contains two attributes, SortBy and\n SortOrder.
The maximum number of results returned by a single call. This value must be provided\n in the next call to retrieve the next set of results. By default, this value is\n 20.
" + } + }, + "NextToken": { + "target": "com.amazonaws.marketplacecatalog#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of\n results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#ListChangeSetsResponse": { + "type": "structure", + "members": { + "ChangeSetSummaryList": { + "target": "com.amazonaws.marketplacecatalog#ChangeSetSummaryList", + "traits": { + "smithy.api#documentation": " Array of ChangeSetSummaryListItem objects.
The value of the next token, if it exists. Null if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.marketplacecatalog#ListEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#ListEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#ListEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.marketplacecatalog#InternalServiceException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides the list of entities of a given type.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListEntities", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EntitySummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.marketplacecatalog#ListEntitiesMaxResultInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.marketplacecatalog#ListEntitiesRequest": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.marketplacecatalog#Catalog", + "traits": { + "smithy.api#documentation": "The catalog related to the request. Fixed value: AWSMarketplace\n
The type of entities to\n retrieve. Valid\n values are: ServerProduct, AmiProduct,\n ContainerProduct, DataProduct, SaaSProduct,\n ProcurementPolicy, Experience, Audience,\n BrandingSettings, Offer, Seller,\n ResaleAuthorization.
An array of filter objects. Each filter object contains two attributes,\n filterName and filterValues.
An object that contains two attributes, SortBy and\n SortOrder.
The value of the next token, if it exists. Null if there are no more results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.marketplacecatalog#ListEntitiesMaxResultInteger", + "traits": { + "smithy.api#documentation": "Specifies the upper limit of the elements on a single page. If a value isn't provided,\n the default value is 20.
" + } + }, + "OwnershipType": { + "target": "com.amazonaws.marketplacecatalog#OwnershipType", + "traits": { + "smithy.api#documentation": "Filters the returned set of entities based on their owner. The default is\n SELF. To list entities shared with you\n through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace\n Catalog API PutResourcePolicy operation can't be discovered through the\n SHARED parameter.
A Union object containing filter shapes for all EntityTypes. Each\n EntityTypeFilter shape will have filters applicable for that\n EntityType that can be used to search or filter entities.
A Union object containing Sort shapes for all EntityTypes.\n Each EntityTypeSort shape will have SortBy and\n SortOrder applicable for fields on that EntityType. This\n can be used to sort the results of the filter query.
Array of EntitySummary objects.
The value of the next token if it exists. Null if there is no more result.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.marketplacecatalog#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacecatalog#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.marketplacecatalog#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.marketplacecatalog#InternalServiceException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.marketplacecatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all tags that have been added to a resource (either an entity or change set).
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTagsForResource", + "code": 200 + } + } + }, + "com.amazonaws.marketplacecatalog#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to list\n tags on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "Required. The ARN associated with the resource you want to list tags on.
" + } + }, + "Tags": { + "target": "com.amazonaws.marketplacecatalog#TagList", + "traits": { + "smithy.api#documentation": "Required. A list of objects specifying each key name and value. Number of objects\n allowed: 1-50.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.marketplacecatalog#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w+=.:@\\-\\/]$" + } + }, + "com.amazonaws.marketplacecatalog#OfferAvailabilityEndDateFilter": { + "type": "structure", + "members": { + "DateRange": { + "target": "com.amazonaws.marketplacecatalog#OfferAvailabilityEndDateFilterDateRange", + "traits": { + "smithy.api#documentation": "Allows filtering on the AvailabilityEndDate of an offer with date range as input.
Allows filtering on the AvailabilityEndDate of an offer.
Allows filtering on the AvailabilityEndDate of an offer after a date.
Allows filtering on the AvailabilityEndDate of an offer before a date.
Allows filtering on the AvailabilityEndDate of an offer with date range as input.
Allows filtering on the BuyerAccounts of an offer with wild card input.
Allows filtering on the BuyerAccounts of an offer.
Allows filtering on entity id of an offer with list input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Allows filtering on the entity id of an offer.
" + } + }, + "com.amazonaws.marketplacecatalog#OfferEntityIdFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#OfferEntityIdString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#OfferEntityIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" + } + }, + "com.amazonaws.marketplacecatalog#OfferFilters": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.marketplacecatalog#OfferEntityIdFilter", + "traits": { + "smithy.api#documentation": "Allows filtering on EntityId of an offer.
Allows filtering on the Name of an offer.
Allows filtering on the ProductId of an offer.
Allows filtering on the ReleaseDate of an offer.
Allows filtering on the AvailabilityEndDate of an offer.
Allows filtering on the BuyerAccounts of an offer.
Allows filtering on the State of an offer.
Allows filtering on the Targeting of an offer.
Allows filtering on the LastModifiedDate of an offer.
A filter for offers entity.
" + } + }, + "com.amazonaws.marketplacecatalog#OfferLastModifiedDateFilter": { + "type": "structure", + "members": { + "DateRange": { + "target": "com.amazonaws.marketplacecatalog#OfferLastModifiedDateFilterDateRange", + "traits": { + "smithy.api#documentation": "Allows filtering on the LastModifiedDate of an offer with date range as input.
Allows filtering on the LastModifiedDate of an offer.
Allows filtering on the LastModifiedDate of an offer after a date.
Allows filtering on the LastModifiedDate of an offer before a date.
Allows filtering on the LastModifiedDate of an offer with date range as input.
Allows filtering on the Name of an offer with list input.
Allows filtering on the Name of an offer with wild card input.
Allows filtering on the Name of an offer.
Allows filtering on the ProductId of an offer with list input.
Allows filtering on the ProductId of an offer.
Allows filtering on the ReleaseDate of an offer with date range as input.
Allows filtering on the ReleaseDate of an offer.
Allows filtering on the ReleaseDate of offers after a date.
Allows filtering on the ReleaseDate of offers before a date.
Allows filtering on the ReleaseDate of an offer with date range as input.
Allows to sort offers.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.marketplacecatalog#SortOrder", + "traits": { + "smithy.api#documentation": "Allows to sort offers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Allows to sort offers.
" + } + }, + "com.amazonaws.marketplacecatalog#OfferSortBy": { + "type": "enum", + "members": { + "EntityId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntityId" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "ProductId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductId" + } + }, + "ReleaseDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReleaseDate" + } + }, + "AvailabilityEndDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AvailabilityEndDate" + } + }, + "BuyerAccounts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BuyerAccounts" + } + }, + "State": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "State" + } + }, + "Targeting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Targeting" + } + }, + "LastModifiedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedDate" + } + } + } + }, + "com.amazonaws.marketplacecatalog#OfferStateFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#OfferStateFilterValueList", + "traits": { + "smithy.api#documentation": "Allows filtering on the State of an offer with list input.
Allows filtering on the State of an offer.
The name of the offer.
" + } + }, + "ProductId": { + "target": "com.amazonaws.marketplacecatalog#OfferProductIdString", + "traits": { + "smithy.api#documentation": "The product ID of the offer.
" + } + }, + "ReleaseDate": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "The release date of the offer.
" + } + }, + "AvailabilityEndDate": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "The availability end date of the offer.
" + } + }, + "BuyerAccounts": { + "target": "com.amazonaws.marketplacecatalog#OfferBuyerAccountsList", + "traits": { + "smithy.api#documentation": "The buyer accounts in the offer.
" + } + }, + "State": { + "target": "com.amazonaws.marketplacecatalog#OfferStateString", + "traits": { + "smithy.api#documentation": "The status of the offer.
" + } + }, + "Targeting": { + "target": "com.amazonaws.marketplacecatalog#OfferTargetingList", + "traits": { + "smithy.api#documentation": "The targeting in the offer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarized information about an offer.
" + } + }, + "com.amazonaws.marketplacecatalog#OfferTargetingFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#OfferTargetingFilterValueList", + "traits": { + "smithy.api#documentation": "Allows filtering on the Targeting of an offer with list input.
Allows filtering on the Targeting of an offer.
Attaches a resource-based policy to an entity. Examples of an entity include:\n AmiProduct and ContainerProduct.
The Amazon Resource Name (ARN) of the entity resource you want to associate with a\n resource policy.
", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.marketplacecatalog#ResourcePolicyJson", + "traits": { + "smithy.api#documentation": "The policy document to set; formatted in JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.marketplacecatalog#PutResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.marketplacecatalog#RequestedChangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#Change" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationAvailabilityEndDateFilter": { + "type": "structure", + "members": { + "DateRange": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationAvailabilityEndDateFilterDateRange", + "traits": { + "smithy.api#documentation": "Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date value as input.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization after a date.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization before a date.
Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input.
Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.
Allows filtering on CreatedDate of a ResaleAuthorization with date value as input.
Allows filtering on CreatedDate of a ResaleAuthorization.
Allows filtering on CreatedDate of a ResaleAuthorization after a date.
Allows filtering on CreatedDate of a ResaleAuthorization before a date.
Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.
Allows filtering on EntityId of a ResaleAuthorization with list input.
Allows filtering on EntityId of a ResaleAuthorization.
Allows filtering on the EntityId of a ResaleAuthorization.
Allows filtering on the Name of a ResaleAuthorization.
Allows filtering on the ProductId of a ResaleAuthorization.
Allows filtering on the CreatedDate of a ResaleAuthorization.
Allows filtering on the AvailabilityEndDate of a ResaleAuthorization.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.
Allows filtering on the ProductName of a ResaleAuthorization.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.
Allows filtering on the ResellerAccountID of a ResaleAuthorization.
Allows filtering on the ResellerLegalName of a ResaleAuthorization.
Allows filtering on the Status of a ResaleAuthorization.
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.
Allows filtering on the LastModifiedDate of a ResaleAuthorization.
A filter for ResaleAuthorization entity.
" + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationLastModifiedDateFilter": { + "type": "structure", + "members": { + "DateRange": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationLastModifiedDateFilterDateRange", + "traits": { + "smithy.api#documentation": "Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.
Allows filtering on the LastModifiedDate of a ResaleAuthorization.
Allows filtering on the LastModifiedDate of a ResaleAuthorization after a date.
Allows filtering on the LastModifiedDate of a ResaleAuthorization before a date.
Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with list input.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with wild card input.
Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with list input.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with wild card input.
Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.
Allows filtering on the Name of a ResaleAuthorization with list input.
Allows filtering on the Name of a ResaleAuthorization with wild card input.
Allows filtering on the Name of a ResaleAuthorization.
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization with list input.
Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.
Allows filtering on the ProductId of a ResaleAuthorization with list input.
Allows filtering on the ProductId of a ResaleAuthorization with wild card input.
Allows filtering on the ProductId of a ResaleAuthorization.
Allows filtering on the ProductName of a ResaleAuthorization with list input.
Allows filtering on the ProductName of a ResaleAuthorization with wild card input.
Allows filtering on the ProductName of a ResaleAuthorization.
Allows filtering on the ResellerAccountID of a ResaleAuthorization with list input.
Allows filtering on the ResellerAccountID of a ResaleAuthorization with wild card input.
Allows filtering on the ResellerAccountID of a ResaleAuthorization.
Allows filtering on the ResellerLegalNameProductName of a ResaleAuthorization with list input.
" + } + }, + "WildCardValue": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerLegalNameFilterWildcard", + "traits": { + "smithy.api#documentation": "Allows filtering on the ResellerLegalName of a ResaleAuthorization with wild card input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Allows filtering on the ResellerLegalName of a ResaleAuthorization.
" + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerLegalNameFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerLegalNameString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerLegalNameFilterWildcard": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(.)+$" + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerLegalNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(.)+$" + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationSort": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationSortBy", + "traits": { + "smithy.api#documentation": "Allows to sort ResaleAuthorization.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.marketplacecatalog#SortOrder", + "traits": { + "smithy.api#documentation": "Allows to sort ResaleAuthorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Allows to sort ResaleAuthorization.
" + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationSortBy": { + "type": "enum", + "members": { + "EntityId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntityId" + } + }, + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "ProductId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductId" + } + }, + "ProductName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductName" + } + }, + "ManufacturerAccountId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManufacturerAccountId" + } + }, + "ManufacturerLegalName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManufacturerLegalName" + } + }, + "ResellerAccountID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResellerAccountID" + } + }, + "ResellerLegalName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResellerLegalName" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + }, + "OfferExtendedStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OfferExtendedStatus" + } + }, + "CreatedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedDate" + } + }, + "AvailabilityEndDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AvailabilityEndDate" + } + }, + "LastModifiedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedDate" + } + } + } + }, + "com.amazonaws.marketplacecatalog#ResaleAuthorizationStatusFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationStatusFilterValueList", + "traits": { + "smithy.api#documentation": "Allows filtering on the Status of a ResaleAuthorization with list input.
Allows filtering on the Status of a ResaleAuthorization.
The name of the ResaleAuthorization.
" + } + }, + "ProductId": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationProductIdString", + "traits": { + "smithy.api#documentation": "The product ID of the ResaleAuthorization.
" + } + }, + "ProductName": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationProductNameString", + "traits": { + "smithy.api#documentation": "The product name of the ResaleAuthorization.
" + } + }, + "ManufacturerAccountId": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationManufacturerAccountIdString", + "traits": { + "smithy.api#documentation": "The manufacturer account ID of the ResaleAuthorization.
" + } + }, + "ManufacturerLegalName": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationManufacturerLegalNameString", + "traits": { + "smithy.api#documentation": "The manufacturer legal name of the ResaleAuthorization.
" + } + }, + "ResellerAccountID": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerAccountIDString", + "traits": { + "smithy.api#documentation": "The reseller account ID of the ResaleAuthorization.
" + } + }, + "ResellerLegalName": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerLegalNameString", + "traits": { + "smithy.api#documentation": "The reseller legal name of the ResaleAuthorization
" + } + }, + "Status": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationStatusString", + "traits": { + "smithy.api#documentation": "The status of the ResaleAuthorization.
" + } + }, + "OfferExtendedStatus": { + "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationOfferExtendedStatusString", + "traits": { + "smithy.api#documentation": "The offer extended status of the ResaleAuthorization
" + } + }, + "CreatedDate": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "The created date of the ResaleAuthorization.
" + } + }, + "AvailabilityEndDate": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "The availability end date of the ResaleAuthorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarized information about a Resale Authorization.
" + } + }, + "com.amazonaws.marketplacecatalog#ResourceARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:aws-marketplace:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" + } + }, + "com.amazonaws.marketplacecatalog#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.marketplacecatalog#ResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#ResourceId" + } + }, + "com.amazonaws.marketplacecatalog#ResourceInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" + } + }, + "traits": { + "smithy.api#documentation": "The resource is currently in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 423 + } + }, + "com.amazonaws.marketplacecatalog#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource wasn't found.
\nHTTP status code: 404
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.marketplacecatalog#ResourceNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" + } + }, + "traits": { + "smithy.api#documentation": "Currently, the specified resource is not supported.
", + "smithy.api#error": "client", + "smithy.api#httpError": 415 + } + }, + "com.amazonaws.marketplacecatalog#ResourcePolicyJson": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.marketplacecatalog#SaaSProductEntityIdFilter": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductEntityIdFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique entity id values to be filtered on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object that allows filtering on entity id of a SaaS product.
" + } + }, + "com.amazonaws.marketplacecatalog#SaaSProductEntityIdFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductEntityIdString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.marketplacecatalog#SaaSProductEntityIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" + } + }, + "com.amazonaws.marketplacecatalog#SaaSProductFilters": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductEntityIdFilter", "traits": { - "smithy.api#documentation": "An object that contains two attributes, SortBy and\n SortOrder.
Unique identifier for the SaaS product.
" } }, - "NextToken": { - "target": "com.amazonaws.marketplacecatalog#NextToken", + "ProductTitle": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleFilter", "traits": { - "smithy.api#documentation": "The value of the next token, if it exists. Null if there are no more results.
" + "smithy.api#documentation": "The title of the SaaS product.
" } }, - "MaxResults": { - "target": "com.amazonaws.marketplacecatalog#ListEntitiesMaxResultInteger", + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilter", "traits": { - "smithy.api#documentation": "Specifies the upper limit of the elements on a single page. If a value isn't provided,\n the default value is 20.
" + "smithy.api#documentation": "The visibility of the SaaS product.
" } }, - "OwnershipType": { - "target": "com.amazonaws.marketplacecatalog#OwnershipType", + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductLastModifiedDateFilter", "traits": { - "smithy.api#documentation": "Filters the returned set of entities based on their owner. The default is\n SELF. To list entities shared with you\n through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace\n Catalog API PutResourcePolicy operation can't be discovered through the\n SHARED parameter.
The last date on which the SaaS product was modified.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Object containing all the filter fields for SaaS products. Client can add a maximum of\n 8 filters in a single ListEntities request.
Array of EntitySummary object.
The value of the next token if it exists. Null if there is no more result.
" + "smithy.api#documentation": "Dates between which the SaaS product was last modified.
" } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.marketplacecatalog#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.marketplacecatalog#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.marketplacecatalog#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" - }, - { - "target": "com.amazonaws.marketplacecatalog#InternalServiceException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ThrottlingException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all tags that have been added to a resource (either an entity or change set).
", - "smithy.api#http": { - "method": "POST", - "uri": "/ListTagsForResource", - "code": 200 - } + "smithy.api#documentation": "Object that allows filtering based on the last modified date of SaaS products
" } }, - "com.amazonaws.marketplacecatalog#ListTagsForResourceRequest": { + "com.amazonaws.marketplacecatalog#SaaSProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.marketplacecatalog#ResourceARN", + "AfterValue": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { - "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to list\n tags on.
", - "smithy.api#required": {} + "smithy.api#documentation": "Date after which the SaaS product was last modified.
" + } + }, + "BeforeValue": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "traits": { + "smithy.api#documentation": "Date before which the SaaS product was last modified.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.
Required. The ARN associated with the resource you want to list tags on.
" + "smithy.api#documentation": "Field to sort the SaaS products by.
" } }, - "Tags": { - "target": "com.amazonaws.marketplacecatalog#TagList", + "SortOrder": { + "target": "com.amazonaws.marketplacecatalog#SortOrder", "traits": { - "smithy.api#documentation": "Required. A list of objects specifying each key name and value. Number of objects\n allowed: 1-50.
" + "smithy.api#documentation": "The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
Objects that allows sorting on SaaS products based on certain fields and sorting order.
" } }, - "com.amazonaws.marketplacecatalog#OwnershipType": { + "com.amazonaws.marketplacecatalog#SaaSProductSortBy": { "type": "enum", "members": { - "SELF": { + "EntityId": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SELF" + "smithy.api#enumValue": "EntityId" } }, - "SHARED": { + "ProductTitle": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SHARED" + "smithy.api#enumValue": "ProductTitle" } - } - } - }, - "com.amazonaws.marketplacecatalog#PutResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.marketplacecatalog#PutResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.marketplacecatalog#PutResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" - }, - { - "target": "com.amazonaws.marketplacecatalog#InternalServiceException" }, - { - "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.marketplacecatalog#ThrottlingException" + "Visibility": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Visibility" + } }, - { - "target": "com.amazonaws.marketplacecatalog#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Attaches a resource-based policy to an entity. Examples of an entity include:\n AmiProduct and ContainerProduct.
The Amazon Resource Name (ARN) of the entity resource you want to associate with a\n resource policy.
", - "smithy.api#required": {} + "smithy.api#documentation": "The title of the SaaS product.
" } }, - "Policy": { - "target": "com.amazonaws.marketplacecatalog#ResourcePolicyJson", + "Visibility": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityString", "traits": { - "smithy.api#documentation": "The policy document to set; formatted in JSON.
", - "smithy.api#required": {} + "smithy.api#documentation": "The lifecycle of the SaaS product.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Object that contains summarized information about a SaaS product.
" } }, - "com.amazonaws.marketplacecatalog#PutResourcePolicyResponse": { + "com.amazonaws.marketplacecatalog#SaaSProductTitleFilter": { "type": "structure", - "members": {}, + "members": { + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique product title values to be filtered on.
" + } + }, + "WildCardValue": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleString", + "traits": { + "smithy.api#documentation": "A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on product title.
" } }, - "com.amazonaws.marketplacecatalog#RequestedChangeList": { + "com.amazonaws.marketplacecatalog#SaaSProductTitleFilterValueList": { "type": "list", "member": { - "target": "com.amazonaws.marketplacecatalog#Change" + "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleString" }, "traits": { "smithy.api#length": { "min": 1, - "max": 20 + "max": 10 } } }, - "com.amazonaws.marketplacecatalog#ResourceARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:aws-marketplace:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" - } - }, - "com.amazonaws.marketplacecatalog#ResourceId": { + "com.amazonaws.marketplacecatalog#SaaSProductTitleString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.marketplacecatalog#ResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.marketplacecatalog#ResourceId" + "smithy.api#pattern": "^(.)+$" } }, - "com.amazonaws.marketplacecatalog#ResourceInUseException": { + "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilter": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilterValueList", + "traits": { + "smithy.api#documentation": "A string array of unique visibility values to be filtered on.
" + } } }, "traits": { - "smithy.api#documentation": "The resource is currently in use.
", - "smithy.api#error": "client", - "smithy.api#httpError": 423 + "smithy.api#documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" } }, - "com.amazonaws.marketplacecatalog#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" - } + "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityString" }, "traits": { - "smithy.api#documentation": "The specified resource wasn't found.
\nHTTP status code: 404
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.marketplacecatalog#ResourceNotSupportedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" + "smithy.api#length": { + "min": 1, + "max": 10 } - }, - "traits": { - "smithy.api#documentation": "Currently, the specified resource is not supported.
", - "smithy.api#error": "client", - "smithy.api#httpError": 415 } }, - "com.amazonaws.marketplacecatalog#ResourcePolicyJson": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10240 + "com.amazonaws.marketplacecatalog#SaaSProductVisibilityString": { + "type": "enum", + "members": { + "Limited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Limited" + } }, - "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Public" + } + }, + "Restricted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Restricted" + } + }, + "Draft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Draft" + } + } } }, "com.amazonaws.marketplacecatalog#ServiceQuotaExceededException": {