github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/marketplace-catalog/2018-09-17/docs-2.json

{
  "version": "2.0",
  "service": "<p>Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace. </p> <p>You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.</p>",
  "operations": {
    "CancelChangeSet": "<p>Used to cancel an open change request. Must be sent before the status of the request changes to <code>APPLYING</code>, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.</p>",
    "DescribeChangeSet": "<p>Provides information about a given change set.</p>",
    "DescribeEntity": "<p>Returns the metadata and content of the entity.</p>",
    "ListChangeSets": "<p>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 <code>entityId</code>, <code>ChangeSetName</code>, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.</p> <p>You can describe a change during the 60-day request history retention period for API calls.</p>",
    "ListEntities": "<p>Provides the list of entities of a given type.</p>",
    "StartChangeSet": "<p>This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a <code>ResourceInUseException</code>.</p> <p>For example, you cannot start the ChangeSet described in the <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples\">example</a> later in this topic, because it contains two changes to execute the same change type (<code>AddRevisions</code>) against the same entity (<code>entity-id@1)</code>.</p> <p>For more information about working with change sets, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\"> Working with change sets</a>.</p>"
  },
  "shapes": {
    "ARN": {
      "base": null,
      "refs": {
        "CancelChangeSetResponse$ChangeSetArn": "<p>The ARN associated with the change set referenced in this request.</p>",
        "ChangeSetSummaryListItem$ChangeSetArn": "<p>The ARN associated with the unique identifier for the change set referenced in this request.</p>",
        "DescribeChangeSetResponse$ChangeSetArn": "<p>The ARN associated with the unique identifier for the change set referenced in this request.</p>",
        "DescribeEntityResponse$EntityArn": "<p>The ARN associated to the unique identifier for the change set referenced in this request.</p>",
        "EntitySummary$EntityArn": "<p>The ARN associated with the unique identifier for the entity.</p>",
        "StartChangeSetResponse$ChangeSetArn": "<p>The ARN associated to the unique identifier generated for the request.</p>"
      }
    },
    "AccessDeniedException": {
      "base": "<p>Access is denied.</p>",
      "refs": {
      }
    },
    "CancelChangeSetRequest": {
      "base": null,
      "refs": {
      }
    },
    "CancelChangeSetResponse": {
      "base": null,
      "refs": {
      }
    },
    "Catalog": {
      "base": null,
      "refs": {
        "CancelChangeSetRequest$Catalog": "<p>Required. The catalog related to the request. Fixed value: <code>AWSMarketplace</code>.</p>",
        "DescribeChangeSetRequest$Catalog": "<p>Required. The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>",
        "DescribeEntityRequest$Catalog": "<p>Required. The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>",
        "ListChangeSetsRequest$Catalog": "<p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>",
        "ListEntitiesRequest$Catalog": "<p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>",
        "StartChangeSetRequest$Catalog": "<p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>"
      }
    },
    "Change": {
      "base": "<p>An object that contains the <code>ChangeType</code>, <code>Details</code>, and <code>Entity</code>.</p>",
      "refs": {
        "RequestedChangeList$member": null
      }
    },
    "ChangeName": {
      "base": null,
      "refs": {
        "Change$ChangeName": "<p>Optional name for the change.</p>",
        "ChangeSummary$ChangeName": "<p>Optional name for the change.</p>"
      }
    },
    "ChangeSetDescription": {
      "base": null,
      "refs": {
        "DescribeChangeSetResponse$ChangeSet": "<p>An array of <code>ChangeSummary</code> objects.</p>"
      }
    },
    "ChangeSetName": {
      "base": null,
      "refs": {
        "ChangeSetSummaryListItem$ChangeSetName": "<p>The non-unique name for the change set.</p>",
        "DescribeChangeSetResponse$ChangeSetName": "<p>The optional name provided in the <code>StartChangeSet</code> request. If you do not provide a name, one is set by default.</p>",
        "StartChangeSetRequest$ChangeSetName": "<p>Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets. </p>"
      }
    },
    "ChangeSetSummaryList": {
      "base": null,
      "refs": {
        "ListChangeSetsResponse$ChangeSetSummaryList": "<p> Array of <code>ChangeSetSummaryListItem</code> objects.</p>"
      }
    },
    "ChangeSetSummaryListItem": {
      "base": "<p>A summary of a change set returned in a list of change sets when the <code>ListChangeSets</code> action is called.</p>",
      "refs": {
        "ChangeSetSummaryList$member": null
      }
    },
    "ChangeStatus": {
      "base": null,
      "refs": {
        "ChangeSetSummaryListItem$Status": "<p>The current status of the change set.</p>",
        "DescribeChangeSetResponse$Status": "<p>The status of the change request.</p>"
      }
    },
    "ChangeSummary": {
      "base": "<p>This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.</p>",
      "refs": {
        "ChangeSetDescription$member": null
      }
    },
    "ChangeType": {
      "base": null,
      "refs": {
        "Change$ChangeType": "<p>Change types are single string values that describe your intention for the change. Each change type is unique for each <code>EntityType</code> provided in the change's scope.</p>",
        "ChangeSummary$ChangeType": "<p>The type of the change.</p>"
      }
    },
    "ClientRequestToken": {
      "base": null,
      "refs": {
        "StartChangeSetRequest$ClientRequestToken": "<p>A unique token to identify the request to ensure idempotency.</p>"
      }
    },
    "DateTimeISO8601": {
      "base": null,
      "refs": {
        "ChangeSetSummaryListItem$StartTime": "<p>The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.</p>",
        "ChangeSetSummaryListItem$EndTime": "<p>The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.</p>",
        "DescribeChangeSetResponse$StartTime": "<p>The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started. </p>",
        "DescribeChangeSetResponse$EndTime": "<p>The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state. </p>",
        "DescribeEntityResponse$LastModifiedDate": "<p>The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).</p>",
        "EntitySummary$LastModifiedDate": "<p>The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).</p>"
      }
    },
    "DescribeChangeSetRequest": {
      "base": null,
      "refs": {
      }
    },
    "DescribeChangeSetResponse": {
      "base": null,
      "refs": {
      }
    },
    "DescribeEntityRequest": {
      "base": null,
      "refs": {
      }
    },
    "DescribeEntityResponse": {
      "base": null,
      "refs": {
      }
    },
    "Entity": {
      "base": "<p>An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer. </p>",
      "refs": {
        "Change$Entity": "<p>The entity to be changed.</p>",
        "ChangeSummary$Entity": "<p>The entity to be changed.</p>"
      }
    },
    "EntityNameString": {
      "base": null,
      "refs": {
        "EntitySummary$Name": "<p>The name for the entity. This value is not unique. It is defined by the seller.</p>"
      }
    },
    "EntitySummary": {
      "base": "<p>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.</p>",
      "refs": {
        "EntitySummaryList$member": null
      }
    },
    "EntitySummaryList": {
      "base": null,
      "refs": {
        "ListEntitiesResponse$EntitySummaryList": "<p> Array of <code>EntitySummary</code> object.</p>"
      }
    },
    "EntityType": {
      "base": null,
      "refs": {
        "DescribeEntityResponse$EntityType": "<p>The named type of the entity, in the format of <code>EntityType@Version</code>.</p>",
        "Entity$Type": "<p>The type of entity.</p>",
        "EntitySummary$EntityType": "<p>The type of the entity.</p>",
        "ListEntitiesRequest$EntityType": "<p>The type of entities to retrieve.</p>"
      }
    },
    "ErrorCodeString": {
      "base": null,
      "refs": {
        "ErrorDetail$ErrorCode": "<p>The error code that identifies the type of error.</p>"
      }
    },
    "ErrorDetail": {
      "base": "<p>Details about the error.</p>",
      "refs": {
        "ErrorDetailList$member": null
      }
    },
    "ErrorDetailList": {
      "base": null,
      "refs": {
        "ChangeSummary$ErrorDetailList": "<p>An array of <code>ErrorDetail</code> objects associated with the change.</p>"
      }
    },
    "ExceptionMessageContent": {
      "base": null,
      "refs": {
        "AccessDeniedException$Message": null,
        "DescribeChangeSetResponse$FailureDescription": "<p>Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.</p>",
        "ErrorDetail$ErrorMessage": "<p>The message for the error.</p>",
        "InternalServiceException$Message": null,
        "ResourceInUseException$Message": null,
        "ResourceNotFoundException$Message": null,
        "ResourceNotSupportedException$Message": null,
        "ServiceQuotaExceededException$Message": null,
        "ThrottlingException$Message": null,
        "ValidationException$Message": null
      }
    },
    "FailureCode": {
      "base": null,
      "refs": {
        "ChangeSetSummaryListItem$FailureCode": "<p>Returned if the change set is in <code>FAILED</code> status. Can be either <code>CLIENT_ERROR</code>, which means that there are issues with the request (see the <code>ErrorDetailList</code> of <code>DescribeChangeSet</code>), or <code>SERVER_FAULT</code>, which means that there is a problem in the system, and you should retry your request.</p>",
        "DescribeChangeSetResponse$FailureCode": "<p>Returned if the change set is in <code>FAILED</code> status. Can be either <code>CLIENT_ERROR</code>, which means that there are issues with the request (see the <code>ErrorDetailList</code>), or <code>SERVER_FAULT</code>, which means that there is a problem in the system, and you should retry your request.</p>"
      }
    },
    "Filter": {
      "base": "<p>A filter object, used to optionally filter results from calls to the <code>ListEntities</code> and <code>ListChangeSets</code> actions.</p>",
      "refs": {
        "FilterList$member": null
      }
    },
    "FilterList": {
      "base": null,
      "refs": {
        "ListChangeSetsRequest$FilterList": "<p>An array of filter objects.</p>",
        "ListEntitiesRequest$FilterList": "<p>An array of filter objects. Each filter object contains two attributes, <code>filterName</code> and <code>filterValues</code>.</p>"
      }
    },
    "FilterName": {
      "base": null,
      "refs": {
        "Filter$Name": "<p>For <code>ListEntities</code>, the supported value for this is an <code>EntityId</code>.</p> <p>For <code>ListChangeSets</code>, the supported values are as follows:</p>"
      }
    },
    "FilterValueContent": {
      "base": null,
      "refs": {
        "ValueList$member": null
      }
    },
    "Identifier": {
      "base": null,
      "refs": {
        "DescribeEntityResponse$EntityIdentifier": "<p>The identifier of the entity, in the format of <code>EntityId@RevisionId</code>.</p>",
        "Entity$Identifier": "<p>The identifier for the entity.</p>"
      }
    },
    "InternalServiceException": {
      "base": "<p>There was an internal service exception.</p>",
      "refs": {
      }
    },
    "Json": {
      "base": null,
      "refs": {
        "Change$Details": "<p>This object contains details specific to the change type of the requested change.</p>",
        "ChangeSummary$Details": "<p>This object contains details specific to the change type of the requested change.</p>",
        "DescribeEntityResponse$Details": "<p>This stringified JSON object includes the details of the entity.</p>"
      }
    },
    "ListChangeSetsRequest": {
      "base": null,
      "refs": {
      }
    },
    "ListChangeSetsResponse": {
      "base": null,
      "refs": {
      }
    },
    "ListEntitiesRequest": {
      "base": null,
      "refs": {
      }
    },
    "ListEntitiesResponse": {
      "base": null,
      "refs": {
      }
    },
    "MaxResultInteger": {
      "base": null,
      "refs": {
        "ListChangeSetsRequest$MaxResults": "<p>The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.</p>",
        "ListEntitiesRequest$MaxResults": "<p>Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.</p>"
      }
    },
    "NextToken": {
      "base": null,
      "refs": {
        "ListChangeSetsRequest$NextToken": "<p>The token value retrieved from a previous call to access the next page of results.</p>",
        "ListChangeSetsResponse$NextToken": "<p>The value of the next token, if it exists. Null if there are no more results.</p>",
        "ListEntitiesRequest$NextToken": "<p>The value of the next token, if it exists. Null if there are no more results.</p>",
        "ListEntitiesResponse$NextToken": "<p>The value of the next token if it exists. Null if there is no more result.</p>"
      }
    },
    "RequestedChangeList": {
      "base": null,
      "refs": {
        "StartChangeSetRequest$ChangeSet": "<p>Array of <code>change</code> object.</p>"
      }
    },
    "ResourceId": {
      "base": null,
      "refs": {
        "CancelChangeSetRequest$ChangeSetId": "<p>Required. The unique identifier of the <code>StartChangeSet</code> request that you want to cancel.</p>",
        "CancelChangeSetResponse$ChangeSetId": "<p>The unique identifier for the change set referenced in this request.</p>",
        "ChangeSetSummaryListItem$ChangeSetId": "<p>The unique identifier for a change set.</p>",
        "DescribeChangeSetRequest$ChangeSetId": "<p>Required. The unique identifier for the <code>StartChangeSet</code> request that you want to describe the details for.</p>",
        "DescribeChangeSetResponse$ChangeSetId": "<p>Required. The unique identifier for the change set referenced in this request.</p>",
        "DescribeEntityRequest$EntityId": "<p>Required. The unique ID of the entity to describe.</p>",
        "EntitySummary$EntityId": "<p>The unique identifier for the entity.</p>",
        "ResourceIdList$member": null,
        "StartChangeSetResponse$ChangeSetId": "<p>Unique identifier generated for the request.</p>"
      }
    },
    "ResourceIdList": {
      "base": null,
      "refs": {
        "ChangeSetSummaryListItem$EntityIdList": "<p>This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of 20 entities. It must contain at least one entity.</p>"
      }
    },
    "ResourceInUseException": {
      "base": "<p>The resource is currently in use.</p>",
      "refs": {
      }
    },
    "ResourceNotFoundException": {
      "base": "<p>The specified resource wasn't found.</p>",
      "refs": {
      }
    },
    "ResourceNotSupportedException": {
      "base": "<p>Currently, the specified resource is not supported.</p>",
      "refs": {
      }
    },
    "ServiceQuotaExceededException": {
      "base": "<p>The maximum number of open requests per account has been exceeded.</p>",
      "refs": {
      }
    },
    "Sort": {
      "base": "<p>An object that contains two attributes, <code>SortBy</code> and <code>SortOrder</code>.</p>",
      "refs": {
        "ListChangeSetsRequest$Sort": "<p>An object that contains two attributes, <code>SortBy</code> and <code>SortOrder</code>.</p>",
        "ListEntitiesRequest$Sort": "<p>An object that contains two attributes, <code>SortBy</code> and <code>SortOrder</code>.</p>"
      }
    },
    "SortBy": {
      "base": null,
      "refs": {
        "Sort$SortBy": "<p>For <code>ListEntities</code>, supported attributes include <code>LastModifiedDate</code> (default), <code>Visibility</code>, <code>EntityId</code>, and <code>Name</code>.</p> <p>For <code>ListChangeSets</code>, supported attributes include <code>StartTime</code> and <code>EndTime</code>.</p>"
      }
    },
    "SortOrder": {
      "base": null,
      "refs": {
        "Sort$SortOrder": "<p>The sorting order. Can be <code>ASCENDING</code> or <code>DESCENDING</code>. The default value is <code>DESCENDING</code>.</p>"
      }
    },
    "StartChangeSetRequest": {
      "base": null,
      "refs": {
      }
    },
    "StartChangeSetResponse": {
      "base": null,
      "refs": {
      }
    },
    "ThrottlingException": {
      "base": "<p>Too many requests.</p>",
      "refs": {
      }
    },
    "ValidationException": {
      "base": "<p>An error occurred during validation.</p>",
      "refs": {
      }
    },
    "ValueList": {
      "base": null,
      "refs": {
        "Filter$ValueList": "<p> <code>ListEntities</code> - This is a list of unique <code>EntityId</code>s.</p> <p> <code>ListChangeSets</code> - The supported filter names and associated <code>ValueList</code>s is as follows:</p> <ul> <li> <p> <code>ChangeSetName</code> - The supported <code>ValueList</code> is a list of non-unique <code>ChangeSetName</code>s. These are defined when you call the <code>StartChangeSet</code> action.</p> </li> <li> <p> <code>Status</code> - The supported <code>ValueList</code> is a list of statuses for all change set requests.</p> </li> <li> <p> <code>EntityId</code> - The supported <code>ValueList</code> is a list of unique <code>EntityId</code>s.</p> </li> <li> <p> <code>BeforeStartTime</code> - The supported <code>ValueList</code> is a list of all change sets that started before the filter value.</p> </li> <li> <p> <code>AfterStartTime</code> - The supported <code>ValueList</code> is a list of all change sets that started after the filter value.</p> </li> <li> <p> <code>BeforeEndTime</code> - The supported <code>ValueList</code> is a list of all change sets that ended before the filter value.</p> </li> <li> <p> <code>AfterEndTime</code> - The supported <code>ValueList</code> is a list of all change sets that ended after the filter value.</p> </li> </ul>"
      }
    },
    "VisibilityValue": {
      "base": null,
      "refs": {
        "EntitySummary$Visibility": "<p>The visibility status of the entity to buyers. This value can be <code>Public</code> (everyone can view the entity), <code>Limited</code> (the entity is visible to limited accounts only), or <code>Restricted</code> (the entity was published and then unpublished and only existing buyers can view it). </p>"
      }
    }
  }
}