{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-marketplace-catalog","description":"AWS Marketplace Catalog Service","version":"2018-09-17","base_url":"","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Marketplace Catalog Service\n@version 2018-09-17\n@auth AWS SigV4\n@endpoints 13\n@toc BatchDescribeEntities(1), CancelChangeSet(1), DeleteResourcePolicy(1), DescribeChangeSet(1), DescribeEntity(1), GetResourcePolicy(1), ListChangeSets(1), ListEntities(1), ListTagsForResource(1), PutResourcePolicy(1), StartChangeSet(1), TagResource(1), UntagResource(1)\n\n@group BatchDescribeEntities\n@endpoint POST /BatchDescribeEntities\n@desc Returns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.\n@required {EntityRequestList: [EntityRequest]}\n@returns(200) {EntityDetails: map<str,EntityDetail>?, Errors: map<str,BatchDescribeErrorDetail>?}\n\n@endgroup\n\n@group CancelChangeSet\n@endpoint PATCH /CancelChangeSet\n@desc Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.\n@required {catalog: str, changeSetId: str}\n@returns(200) {ChangeSetId: str?, ChangeSetArn: str?}\n\n@endgroup\n\n@group DeleteResourcePolicy\n@endpoint DELETE /DeleteResourcePolicy\n@desc Deletes a resource-based policy on an entity that is identified by its resource ARN.\n@required {resourceArn: str}\n\n@endgroup\n\n@group DescribeChangeSet\n@endpoint GET /DescribeChangeSet\n@desc Provides information about a given change set.\n@required {catalog: str, changeSetId: str}\n@returns(200) {ChangeSetId: str?, ChangeSetArn: str?, ChangeSetName: str?, Intent: str?, StartTime: str?, EndTime: str?, Status: str?, FailureCode: str?, FailureDescription: str?, ChangeSet: [ChangeSummary]?}\n\n@endgroup\n\n@group DescribeEntity\n@endpoint GET /DescribeEntity\n@desc Returns the metadata and content of the entity.\n@required {catalog: str, entityId: str}\n@returns(200) {EntityType: str?, EntityIdentifier: str?, EntityArn: str?, LastModifiedDate: str?, Details: str?, DetailsDocument: JsonDocumentType?}\n\n@endgroup\n\n@group GetResourcePolicy\n@endpoint GET /GetResourcePolicy\n@desc Gets a resource-based policy of an entity that is identified by its resource ARN.\n@required {resourceArn: str}\n@returns(200) {Policy: str?}\n\n@endgroup\n\n@group ListChangeSets\n@endpoint POST /ListChangeSets\n@desc Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls.\n@required {Catalog: str}\n@optional {FilterList: [Filter], Sort: Sort, MaxResults: int, NextToken: str}\n@returns(200) {ChangeSetSummaryList: [ChangeSetSummaryListItem]?, NextToken: str?}\n\n@endgroup\n\n@group ListEntities\n@endpoint POST /ListEntities\n@desc Provides the list of entities of a given type.\n@required {Catalog: str, EntityType: str}\n@optional {FilterList: [Filter], Sort: Sort, NextToken: str, MaxResults: int, OwnershipType: str, EntityTypeFilters: EntityTypeFilters, EntityTypeSort: EntityTypeSort}\n@returns(200) {EntitySummaryList: [EntitySummary]?, NextToken: str?}\n\n@endgroup\n\n@group ListTagsForResource\n@endpoint POST /ListTagsForResource\n@desc Lists all tags that have been added to a resource (either an entity or change set).\n@required {ResourceArn: str}\n@returns(200) {ResourceArn: str?, Tags: [Tag]?}\n\n@endgroup\n\n@group PutResourcePolicy\n@endpoint POST /PutResourcePolicy\n@desc Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.\n@required {ResourceArn: str, Policy: str}\n\n@endgroup\n\n@group StartChangeSet\n@endpoint POST /StartChangeSet\n@desc Allows you to request changes for your entities. Within a single ChangeSet, you can't start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException error. For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same change type (AddRevisions) against the same entity (entity-id@1). For more information about working with change sets, see  Working with change sets. For information about change types for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.\n@required {Catalog: str, ChangeSet: [Change]}\n@optional {ChangeSetName: str, ClientRequestToken: str, ChangeSetTags: [Tag], Intent: str}\n@returns(200) {ChangeSetId: str?, ChangeSetArn: str?}\n\n@endgroup\n\n@group TagResource\n@endpoint POST /TagResource\n@desc Tags a resource (either an entity or change set).\n@required {ResourceArn: str, Tags: [Tag]}\n\n@endgroup\n\n@group UntagResource\n@endpoint POST /UntagResource\n@desc Removes a tag or list of tags from a resource (either an entity or change set).\n@required {ResourceArn: str, TagKeys: [str]}\n\n@endgroup\n\n@end\n"}