{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.marketplacecatalog#AMISecurityFilters": { "type": "structure", "members": { "DeliveryOptionId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "
The unique ID of the delivery option whose AMI Security assessments you want to\n list.
" } } }, "traits": { "smithy.api#documentation": "Filters that apply to assessments performed against the AMI Security framework.
" } }, "com.amazonaws.marketplacecatalog#AMISecuritySummary": { "type": "structure", "members": { "DeliveryOptionId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the delivery option that was evaluated.
" } } }, "traits": { "smithy.api#documentation": "The details of the resource assessed under the AMI Security framework.
" } }, "com.amazonaws.marketplacecatalog#ARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[a-zA-Z0-9:*/-]+$" } }, "com.amazonaws.marketplacecatalog#AWSMPSeymour": { "type": "service", "version": "2018-09-17", "operations": [ { "target": "com.amazonaws.marketplacecatalog#BatchDescribeEntities" }, { "target": "com.amazonaws.marketplacecatalog#CancelChangeSet" }, { "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicy" }, { "target": "com.amazonaws.marketplacecatalog#DescribeAssessment" }, { "target": "com.amazonaws.marketplacecatalog#DescribeChangeSet" }, { "target": "com.amazonaws.marketplacecatalog#DescribeEntity" }, { "target": "com.amazonaws.marketplacecatalog#GetResourcePolicy" }, { "target": "com.amazonaws.marketplacecatalog#ListAssessments" }, { "target": "com.amazonaws.marketplacecatalog#ListChangeSets" }, { "target": "com.amazonaws.marketplacecatalog#ListEntities" }, { "target": "com.amazonaws.marketplacecatalog#ListTagsForResource" }, { "target": "com.amazonaws.marketplacecatalog#PutResourcePolicy" }, { "target": "com.amazonaws.marketplacecatalog#StartAssessment" }, { "target": "com.amazonaws.marketplacecatalog#StartChangeSet" }, { "target": "com.amazonaws.marketplacecatalog#TagResource" }, { "target": "com.amazonaws.marketplacecatalog#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Catalog", "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceCatalog", "cloudTrailEventSource": "marketplacecatalog.amazonaws.com", "endpointPrefix": "catalog.marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Catalog API actions allow you to manage your entities through list, describe, and\n update capabilities. An entity can be a product or an offer on AWS Marketplace.
\nYou can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.
", "smithy.api#title": "AWS Marketplace Catalog Service", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://catalog-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://catalog.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://catalog.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://catalog.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://catalog.marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAkAAAAGAAAABQAAAAcF9eELAAAABgX14QQAAAAIAAAABwX14QkF9eEKAAAABAAAAAsAAAAKAAAABQX14QYF9eEIAAAABQAAAAwF9eEHAAAABwX14QUF9eEGAAAAAwX14QEAAAAOAAAABQX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://catalog-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://catalog.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://catalog.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://catalog.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://catalog.marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://catalog-marketplace.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://catalog.marketplace.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.marketplacecatalog#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" } }, "traits": { "smithy.api#documentation": "Access is denied.
\nHTTP status code: 403
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.marketplacecatalog#AdditionalResource": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.marketplacecatalog#ResourceType", "traits": { "smithy.api#documentation": "The type of the resource. Currently, the only value that the service returns is\n Link.
The text to display for the resource.
", "smithy.api#required": {} } }, "Url": { "target": "com.amazonaws.marketplacecatalog#ResourceUrl", "traits": { "smithy.api#documentation": "The URL of the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An additional resource for a listing, with its type, display text, and URL.
" } }, "com.amazonaws.marketplacecatalog#AdditionalResourceList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#AdditionalResource" }, "traits": { "smithy.api#length": { "min": 1, "max": 8 } } }, "com.amazonaws.marketplacecatalog#AdditionalResourcesAlternative": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.marketplacecatalog#AdditionalResourceList", "traits": { "smithy.api#documentation": "The proposed additional resources.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this alternative is recommended.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A proposed set of additional resources for a listing.
" } }, "com.amazonaws.marketplacecatalog#AdditionalResourcesAlternativeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#AdditionalResourcesAlternative" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.marketplacecatalog#AmiProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#AmiProductEntityIdFilterValueList", "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 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 only one wildcard filter and 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#AssessmentIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(assessment-[a-zA-Z0-9]+|arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[0-9]*:[a-zA-Z0-9-]+/Assessment/assessment-[a-zA-Z0-9]+)$" } }, "com.amazonaws.marketplacecatalog#AssessmentResult": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } } } }, "com.amazonaws.marketplacecatalog#AssessmentSummary": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.marketplacecatalog#ARN", "traits": { "smithy.api#documentation": "The ARN associated with the assessment.
" } }, "AssessmentId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the assessment.
" } }, "FrameworkId": { "target": "com.amazonaws.marketplacecatalog#VersionedFrameworkId", "traits": { "smithy.api#documentation": "The identifier of the framework that was evaluated by this assessment, in the format\n frameworkId@version (for example,\n AMISecurity@1.0).
Identifies the entity or change set that was assessed.
" } }, "FrameworkSummary": { "target": "com.amazonaws.marketplacecatalog#FrameworkSummary", "traits": { "smithy.api#documentation": "The framework-specific details of the assessed resource. The set member corresponds\n to the framework identified by FrameworkId.
The overall result of the assessment.
" } }, "CreatedAt": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The date and time the assessment was created, in ISO 8601 format\n (2018-02-27T13:45:22Z).
The date and time the assessment expires, in ISO 8601 format\n (2018-02-27T13:45:22Z).
Summarized information about an assessment.
" } }, "com.amazonaws.marketplacecatalog#AssessmentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#AssessmentSummary" } }, "com.amazonaws.marketplacecatalog#AssessmentTargetFilter": { "type": "structure", "members": { "EntityId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the entity whose assessments you want to list.
" } }, "ChangeSetId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the change set that triggered the assessments you want to\n list.
" } }, "EntityIds": { "target": "com.amazonaws.marketplacecatalog#EntityIdList", "traits": { "smithy.api#documentation": "A list of up to 50 entity IDs whose assessments you want to list. The response includes\n only the latest published assessment of each entity. You must also specify\n FrameworkId in the request, and you can't combine EntityIds\n with EntityId or ChangeSetId.
Filters assessment list results by the resource that was assessed. Provide an entity\n identifier, a change set identifier, or both.
" } }, "com.amazonaws.marketplacecatalog#AssessmentTargetSummary": { "type": "structure", "members": { "EntityId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the entity that was assessed.
" } }, "ChangeSetId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the change set that was assessed.
" } } }, "traits": { "smithy.api#documentation": "Identifies the entity or change set that was assessed.
" } }, "com.amazonaws.marketplacecatalog#BatchDescribeEntities": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#BatchDescribeEntitiesRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#BatchDescribeEntitiesResponse" }, "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 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.
List of entity IDs and the catalogs the entities are present in.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#BatchDescribeEntitiesResponse": { "type": "structure", "members": { "EntityDetails": { "target": "com.amazonaws.marketplacecatalog#EntityDetails", "traits": { "smithy.api#documentation": "Details about each entity.
" } }, "Errors": { "target": "com.amazonaws.marketplacecatalog#Errors", "traits": { "smithy.api#documentation": "A map of errors returned, with EntityId as the key and\n errorDetail as the value.
The error code returned.
" } }, "ErrorMessage": { "target": "com.amazonaws.marketplacecatalog#BatchDescribeErrorMessageContent", "traits": { "smithy.api#documentation": "The error message returned.
" } } }, "traits": { "smithy.api#documentation": "An object that contains an error code and error message.
" } }, "com.amazonaws.marketplacecatalog#BatchDescribeErrorMessageContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#CancelChangeSet": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#CancelChangeSetRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#CancelChangeSetResponse" }, "errors": [ { "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" }, { "target": "com.amazonaws.marketplacecatalog#InternalServiceException" }, { "target": "com.amazonaws.marketplacecatalog#ResourceInUseException" }, { "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacecatalog#ThrottlingException" }, { "target": "com.amazonaws.marketplacecatalog#ValidationException" } ], "traits": { "smithy.api#documentation": "Used to cancel an open change request. Must be sent before the status of the request\n changes to APPLYING, the final stage of completing your change request. You\n can describe a change during the 60-day request history retention period for API\n calls.
Required. The catalog related to the request. Fixed value:\n AWSMarketplace.
Required. The unique identifier of the StartChangeSet request that you\n want to cancel.
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 change set referenced in this request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#CaseStudiesAlternative": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.marketplacecatalog#CaseStudyList", "traits": { "smithy.api#documentation": "The proposed case studies.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this set of case studies fits the solution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A proposed set of case studies for a solution.
" } }, "com.amazonaws.marketplacecatalog#CaseStudiesAlternativeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#CaseStudiesAlternative" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.marketplacecatalog#CaseStudyList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ListingCaseStudy" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.marketplacecatalog#CaseStudyTitle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.marketplacecatalog#Catalog": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^(?![.-])(?!.*[.-]{2})(?![0-9]+\\.[0-9.]+$)[a-zA-Z0-9.-]{1,47}(?Change types are single string values that describe your intention for the change.\n Each change type is unique for eachEntityType provided in the change's\n scope. For more information about change types available for single-AMI products, see\n Working with single-AMI products. Also, for more information about change\n types available for container-based products, see Working with container products.",
"smithy.api#required": {}
}
},
"Entity": {
"target": "com.amazonaws.marketplacecatalog#Entity",
"traits": {
"smithy.api#documentation": "The entity to be changed.
", "smithy.api#required": {} } }, "EntityTags": { "target": "com.amazonaws.marketplacecatalog#TagList", "traits": { "smithy.api#documentation": "The tags associated with the change.
" } }, "Details": { "target": "com.amazonaws.marketplacecatalog#Json", "traits": { "smithy.api#documentation": "This object contains details specific to the change type of the requested change. For\n more information about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change\n types available for container-based products, see Working with container products.
" } }, "DetailsDocument": { "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", "traits": { "smithy.api#documentation": "Alternative field that accepts a JSON value instead of a string for\n ChangeType details. You can use either Details or\n DetailsDocument, but not both.
To download the \"DetailsDocument\" shapes, see the Python \n and Java shapes on GitHub.
" } }, "ChangeName": { "target": "com.amazonaws.marketplacecatalog#ChangeName", "traits": { "smithy.api#documentation": "Optional name for the change.
" } } }, "traits": { "smithy.api#documentation": "An object that contains the ChangeType, Details, and\n Entity.
The unique identifier for a change set.
" } }, "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 non-unique name for the change set.
" } }, "StartTime": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was\n started.
" } }, "EndTime": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was\n finished.
" } }, "Status": { "target": "com.amazonaws.marketplacecatalog#ChangeStatus", "traits": { "smithy.api#documentation": "The current status of the change set.
" } }, "EntityIdList": { "target": "com.amazonaws.marketplacecatalog#ResourceIdList", "traits": { "smithy.api#documentation": "This object is a list of entity IDs (string) that are a part of a change set. The\n entity ID list is a maximum of 20 entities. It must contain at least one entity.
" } }, "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 of DescribeChangeSet), or\n SERVER_FAULT, which means that there is a problem in the system, and\n you should retry your request.
A summary of a change set returned in a list of change sets when the\n ListChangeSets action is called.
The type of the change.
" } }, "Entity": { "target": "com.amazonaws.marketplacecatalog#Entity", "traits": { "smithy.api#documentation": "The entity to be changed.
" } }, "Details": { "target": "com.amazonaws.marketplacecatalog#Json", "traits": { "smithy.api#documentation": "This object contains details specific to the change type of the requested\n change.
" } }, "DetailsDocument": { "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", "traits": { "smithy.api#documentation": "The JSON value of the details specific to the change type of the requested change.
\nTo download the \"DetailsDocument\" shapes, see the Python \n and Java shapes on GitHub.
" } }, "ErrorDetailList": { "target": "com.amazonaws.marketplacecatalog#ErrorDetailList", "traits": { "smithy.api#documentation": "An array of ErrorDetail objects associated with the change.
Optional name for the change.
" } } }, "traits": { "smithy.api#documentation": "This object is a container for common summary information about the change. The\n summary doesn't contain the whole change structure.
" } }, "com.amazonaws.marketplacecatalog#ChangeType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[A-Z][\\w]*$" } }, "com.amazonaws.marketplacecatalog#CitationList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#RecommendationCitation" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.marketplacecatalog#CitationUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^https://\\S+$" } }, "com.amazonaws.marketplacecatalog#ClientRequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]+$" } }, "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#documentation": "Object that allows filtering on entity id of a container product.
" } }, "com.amazonaws.marketplacecatalog#ContainerProductEntityIdFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ContainerProductEntityIdString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "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": { "EntityId": { "target": "com.amazonaws.marketplacecatalog#ContainerProductEntityIdFilter", "traits": { "smithy.api#documentation": "Unique identifier for the container product.
" } }, "LastModifiedDate": { "target": "com.amazonaws.marketplacecatalog#ContainerProductLastModifiedDateFilter", "traits": { "smithy.api#documentation": "The last date on which the container product was modified.
" } }, "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleFilter", "traits": { "smithy.api#documentation": "The title of the container product.
" } }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilter", "traits": { "smithy.api#documentation": "The visibility of the container product.
" } } }, "traits": { "smithy.api#documentation": "Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.
Dates between which the container product was last modified.
" } } }, "traits": { "smithy.api#documentation": "Object that allows filtering based on the last modified date of container products.
" } }, "com.amazonaws.marketplacecatalog#ContainerProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "Date after which the container product was last modified.
" } }, "BeforeValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "Date before which the container 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 container 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 container products based on certain fields and sorting order.
" } }, "com.amazonaws.marketplacecatalog#ContainerProductSortBy": { "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" } }, "CompatibleAWSServices": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CompatibleAWSServices" } } } }, "com.amazonaws.marketplacecatalog#ContainerProductSummary": { "type": "structure", "members": { "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleString", "traits": { "smithy.api#documentation": "The title of the container product.
" } }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityString", "traits": { "smithy.api#documentation": "The lifecycle of the product.
" } } }, "traits": { "smithy.api#documentation": "Object that contains summarized information about a container product.
" } }, "com.amazonaws.marketplacecatalog#ContainerProductTitleFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleFilterValueList", "traits": { "smithy.api#documentation": "A string array of unique product title values to be filtered on.
" } }, "WildCardValue": { "target": "com.amazonaws.marketplacecatalog#ContainerProductTitleString", "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#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": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#ContainerProductVisibilityFilterValueList", "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#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#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#ContainerSecurityFilters": { "type": "structure", "members": { "DeliveryOptionId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the delivery option whose Container Security assessments you want\n to list.
" } } }, "traits": { "smithy.api#documentation": "Filters that apply to assessments performed against the Container Security\n framework.
" } }, "com.amazonaws.marketplacecatalog#ContainerSecuritySummary": { "type": "structure", "members": { "DeliveryOptionId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the delivery option that was evaluated.
" } } }, "traits": { "smithy.api#documentation": "The details of the resource assessed under the Container Security framework.
" } }, "com.amazonaws.marketplacecatalog#ContentAlternatives": { "type": "union", "members": { "Text": { "target": "com.amazonaws.marketplacecatalog#TextAlternativeList", "traits": { "smithy.api#documentation": "The proposed values for a text field, such as ProductTitle or\n LongDescription. You can have up to 3 alternatives.
The proposed values for Highlights, SearchKeywords, or\n Categories. You can have up to 3 alternatives.
The proposed values for AdditionalResources. You can have up to 3\n alternatives.
The proposed values for UseCases. You can have up to 3 alternatives.
The proposed values for CaseStudies. You can have up to 3\n alternatives.
The proposed values for a listing field. Exactly one member is set, depending on\n the field. The list in that member is empty if the status of the recommendation is\n INSUFFICIENT_CONTEXT.
The status of the recommendation. Valid values are:
\n\n GENERATED - The service proposed values for the field.
\n INSUFFICIENT_CONTEXT - The service couldn't propose a value. The follow-up questions say what is missing.
The proposed values for the field, in ranked order.
", "smithy.api#required": {} } }, "FollowUpQuestions": { "target": "com.amazonaws.marketplacecatalog#FollowUpQuestionList", "traits": { "smithy.api#documentation": "Questions that you can answer to get a better recommendation. The list is empty if\n there are none.
", "smithy.api#required": {} } }, "Findings": { "target": "com.amazonaws.marketplacecatalog#FindingList", "traits": { "smithy.api#documentation": "The checklist of criteria for the field, in ranked order. It includes the criteria\n that the field passes and the criteria that it fails. The list is empty if there are\n none.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A recommendation for a listing field.
" } }, "com.amazonaws.marketplacecatalog#ContentRecommendationStatus": { "type": "enum", "members": { "GENERATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GENERATED" } }, "INSUFFICIENT_CONTEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSUFFICIENT_CONTEXT" } } } }, "com.amazonaws.marketplacecatalog#ControlAssessment": { "type": "structure", "members": { "ControlId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the control that was evaluated.
" } }, "ControlAssessmentResult": { "target": "com.amazonaws.marketplacecatalog#ControlAssessmentResult", "traits": { "smithy.api#documentation": "The result of the control evaluation.
" } }, "VerificationSource": { "target": "com.amazonaws.marketplacecatalog#VerificationSource", "traits": { "smithy.api#documentation": "Where the result of the control came from. This value doesn't say whether the control\n passed. A control that you attested to can still have a result of PASS. Valid values\n are:
\n AWS_VERIFIED - AWS evaluated the control.
\n SELF_ATTESTED - You attested to the result of the control.
An array of ControlError objects associated with the control\n evaluation.
A summary of what the control produced, such as recommendations for the listing.
" } } }, "traits": { "smithy.api#documentation": "The result of evaluating a single control as part of an assessment.
" } }, "com.amazonaws.marketplacecatalog#ControlAssessmentList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ControlAssessment" } }, "com.amazonaws.marketplacecatalog#ControlAssessmentResult": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } }, "NOT_EXECUTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_EXECUTED" } }, "EXEMPTION_PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXEMPTION_PASS" } } } }, "com.amazonaws.marketplacecatalog#ControlError": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.marketplacecatalog#ErrorCode", "traits": { "smithy.api#documentation": "The error code that identifies the type of error.
" } }, "Message": { "target": "com.amazonaws.marketplacecatalog#ErrorMessage", "traits": { "smithy.api#documentation": "The message for the error.
" } }, "Scope": { "target": "com.amazonaws.marketplacecatalog#ErrorScopeList", "traits": { "smithy.api#documentation": "The list of name-value pairs that identify the resource or attribute that the error\n applies to.
" } } }, "traits": { "smithy.api#documentation": "An error reported during the evaluation of a single control.
" } }, "com.amazonaws.marketplacecatalog#ControlErrorList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ControlError" } }, "com.amazonaws.marketplacecatalog#ControlInput": { "type": "structure", "members": { "ControlId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the control to run.
", "smithy.api#required": {} } }, "Input": { "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", "traits": { "smithy.api#documentation": "Optional. The input for the control, as a JSON document. The fields that a control accepts\n depend on the control.
" } } }, "traits": { "smithy.api#documentation": "A control to run as part of an assessment, and the input to run it with.
" } }, "com.amazonaws.marketplacecatalog#ControlInputList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ControlInput" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.marketplacecatalog#ControlSummary": { "type": "union", "members": { "ListingRecommendations": { "target": "com.amazonaws.marketplacecatalog#ListingRecommendations", "traits": { "smithy.api#documentation": "The recommendations that a listing recommendations control produced for the\n listing.
" } } }, "traits": { "smithy.api#documentation": "A summary of what a control produced. Exactly one member is set, corresponding to\n the kind of control.
" } }, "com.amazonaws.marketplacecatalog#DataProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#DataProductEntityIdFilterValueList", "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 data product.
" } }, "com.amazonaws.marketplacecatalog#DataProductEntityIdFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#DataProductEntityIdString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#DataProductEntityIdString": { "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#DataProductFilters": { "type": "structure", "members": { "EntityId": { "target": "com.amazonaws.marketplacecatalog#DataProductEntityIdFilter", "traits": { "smithy.api#documentation": "Unique identifier for the data product.
" } }, "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#DataProductTitleFilter", "traits": { "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": "Object containing all the filter fields for data products. Client can add only one wildcard filter and 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#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#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.
" } }, "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#DataProductSortBy": { "type": "enum", "members": { "EntityId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EntityId" } }, "ProductTitle": { "target": "smithy.api#Unit", "traits": { "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#DataProductSummary": { "type": "structure", "members": { "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#DataProductTitleString", "traits": { "smithy.api#documentation": "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#DataProductTitleFilterValueList", "traits": { "smithy.api#documentation": "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.
Object that allows filtering on product title.
" } }, "com.amazonaws.marketplacecatalog#DataProductTitleFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#DataProductTitleString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#DataProductTitleString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "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": 10 } } }, "com.amazonaws.marketplacecatalog#DataProductVisibilityString": { "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" } }, "Unavailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unavailable" } }, "Draft": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Draft" } } } }, "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#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#DeleteResourcePolicyResponse" }, "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 } } }, "com.amazonaws.marketplacecatalog#DeleteResourcePolicyRequest": { "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#DeleteResourcePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#DescribeAssessment": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#DescribeAssessmentRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#DescribeAssessmentResponse" }, "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": "Returns the metadata and detailed results of a single assessment, including the\n framework that was evaluated, the overall assessment result, and a paginated list of\n individual control evaluation results.
\nTo list available assessments before describing one, use the\n ListAssessments action.
The catalog related to the request. Fixed value: AWSMarketplace\n
The unique identifier of the assessment to describe. You can provide either\n the assessment ID (for example, assessment-12345) or the full\n assessment ARN (for example,\n arn:aws:aws-marketplace:us-east-1::AWSMarketplace/Assessment/assessment-12345).
Specifies the upper limit of ControlAssessment elements returned on a\n single page. If a value isn't provided, the default value is 50. Valid values range\n from 1 to 100.
The value of the next token, if it exists. null if there are no more\n results.
The ARN associated with the assessment.
" } }, "AssessmentId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the assessment.
" } }, "FrameworkId": { "target": "com.amazonaws.marketplacecatalog#VersionedFrameworkId", "traits": { "smithy.api#documentation": "The identifier of the framework that was evaluated by this assessment, in the format\n frameworkId@version (for example,\n AMISecurity@1.0).
Identifies the entity or change set that was assessed.
" } }, "FrameworkSummary": { "target": "com.amazonaws.marketplacecatalog#FrameworkSummary", "traits": { "smithy.api#documentation": "The framework-specific details of the assessed resource. The set member corresponds\n to the framework identified by FrameworkId.
The overall result of the assessment.
" } }, "CreatedAt": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The date and time the assessment was created, in ISO 8601 format\n (2018-02-27T13:45:22Z).
The date and time the assessment expires, in ISO 8601 format\n (2018-02-27T13:45:22Z).
An array of ControlAssessment objects, each containing the result of an\n individual control evaluated as part of the assessment.
The value of the next token, if it exists. null if there are no more\n results.
Provides information about a given change set.
", "smithy.api#http": { "method": "GET", "uri": "/DescribeChangeSet", "code": 200 } } }, "com.amazonaws.marketplacecatalog#DescribeChangeSetRequest": { "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 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.
" } }, "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 optional intent provided in the StartChangeSet request. If you do not\n provide an intent, APPLY is set by default.
The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.\n
" } }, "EndTime": { "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.
Returns the metadata and content of the entity.
", "smithy.api#http": { "method": "GET", "uri": "/DescribeEntity", "code": 200 } } }, "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#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.
\nTo download \"DetailsDocument\" shapes, see the Python \n and Java shapes on GitHub.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#Entity": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { "smithy.api#documentation": "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#EntityDetail": { "type": "structure", "members": { "EntityType": { "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { "smithy.api#documentation": "The entity type of the entity, in the format of\n EntityType@Version.
The Amazon Resource Name (ARN) of the entity.
" } }, "EntityIdentifier": { "target": "com.amazonaws.marketplacecatalog#Identifier", "traits": { "smithy.api#documentation": "The ID of the entity, in the format of EntityId@RevisionId.
The last time the entity was modified.
" } }, "DetailsDocument": { "target": "com.amazonaws.marketplacecatalog#JsonDocumentType", "traits": { "smithy.api#documentation": "An object that contains all the details of the entity.
" } } }, "traits": { "smithy.api#documentation": "An object that contains metadata and details about the entity.
" } }, "com.amazonaws.marketplacecatalog#EntityDetails": { "type": "map", "key": { "target": "com.amazonaws.marketplacecatalog#EntityId" }, "value": { "target": "com.amazonaws.marketplacecatalog#EntityDetail" } }, "com.amazonaws.marketplacecatalog#EntityId": { "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#EntityIdList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ResourceId" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.marketplacecatalog#EntityNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^\\\\S+[\\\\S\\\\s]*$" } }, "com.amazonaws.marketplacecatalog#EntityRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.marketplacecatalog#Catalog", "traits": { "smithy.api#documentation": "The name of the catalog the entity is present in. The only value at this time is\n AWSMarketplace.
The ID of the entity.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that contains entity ID and the catalog in which the entity is present.
" } }, "com.amazonaws.marketplacecatalog#EntityRequestList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#EntityRequest" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.marketplacecatalog#EntityRevision": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "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 the entity.
" } }, "EntityId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "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.
" } }, "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.
" } }, "MachineLearningProductSummary": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductSummary" }, "OfferSetSummary": { "target": "com.amazonaws.marketplacecatalog#OfferSetSummary", "traits": { "smithy.api#documentation": "An object that contains summary information about the offer set.
" } }, "ExpressPrivateOfferConfigurationSummary": { "target": "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationSummary", "traits": { "smithy.api#documentation": "An object that contains summary information about the express private offer configuration.
" } }, "SubsidiaryAuthorizationSummary": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummary", "traits": { "smithy.api#documentation": "An object that contains summary information about the subsidiary authorization, such as its\n status and authorized resource, when the entity type is\n SubsidiaryAuthorization.
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.
" } }, "MachineLearningProductFilters": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductFilters" }, "OfferSetFilters": { "target": "com.amazonaws.marketplacecatalog#OfferSetFilters", "traits": { "smithy.api#documentation": "A filter for offer sets.
" } }, "ExpressPrivateOfferConfigurationFilters": { "target": "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationFilters", "traits": { "smithy.api#documentation": "A filter for express private offer configurations.
" } }, "SubsidiaryAuthorizationFilters": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationFilters", "traits": { "smithy.api#documentation": "A filter for subsidiary 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.
" } }, "MachineLearningProductSort": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductSort" }, "OfferSetSort": { "target": "com.amazonaws.marketplacecatalog#OfferSetSort", "traits": { "smithy.api#documentation": "A sort for offer sets.
" } }, "ExpressPrivateOfferConfigurationSort": { "target": "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationSort", "traits": { "smithy.api#documentation": "A sort for express private offer configurations.
" } }, "SubsidiaryAuthorizationSort": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSort", "traits": { "smithy.api#documentation": "A sort for subsidiary authorizations.
" } } }, "traits": { "smithy.api#documentation": "Object containing all the sort fields per entity type.
" } }, "com.amazonaws.marketplacecatalog#ErrorCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Z_]+$" } }, "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#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.marketplacecatalog#ErrorScope": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.marketplacecatalog#ScopeName", "traits": { "smithy.api#documentation": "The name of the resource field the error applies to (for example,\n AMI_ID, FILE_PATH, or PACKAGE_NAME).
The value of the resource field the error applies to.
" } } }, "traits": { "smithy.api#documentation": "A name-value pair that identifies the resource or attribute that a\n ControlError applies to.
A list of EntityId values to filter on.
The filter for the EntityId of an express private offer configuration.
You can filter on the EntityId of an express private offer configuration.
You can filter on the ProductId of an express private offer configuration.
The state of the express private offer configuration to filter on. Valid values are the following:
\n\n ACTIVE \u2013 The configuration is active and you can use it to generate offers.
\n INACTIVE \u2013 The configuration is deprecated or deleted.
The filter fields for the express private offer configuration entity.
" } }, "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationProductIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationProductIdFilterValueList", "traits": { "smithy.api#documentation": "A list of ProductId values to filter on.
The filter for the ProductId of an express private offer configuration.
The field to sort by. Valid values are EntityId, LastModifiedDate, ProductId, and State.
The sorting order. Valid values are ASCENDING and DESCENDING.
The sort fields for express private offer configurations.
" } }, "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationSortBy": { "type": "enum", "members": { "EntityId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EntityId" } }, "LastModifiedDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } }, "ProductId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ProductId" } }, "State": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "State" } } } }, "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationStateFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationStateFilterValueList", "traits": { "smithy.api#documentation": "A list of State values to filter on. Valid values are ACTIVE and INACTIVE.
The filter for the State of an express private offer configuration.
The product ID associated with the express private offer configuration.
" } }, "State": { "target": "com.amazonaws.marketplacecatalog#ExpressPrivateOfferConfigurationStateString", "traits": { "smithy.api#documentation": "The state of the express private offer configuration. Valid values are the following:
\n\n ACTIVE \u2013 The configuration is active and you can use it to generate offers.
\n INACTIVE \u2013 The configuration is deprecated or deleted.
Summarized information about an express private offer configuration.
" } }, "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#FeatureRecommendation": { "type": "structure", "members": { "FeatureId": { "target": "com.amazonaws.marketplacecatalog#RecommendedFeatureId", "traits": { "smithy.api#documentation": "The feature that is recommended. Valid values are\n REQUEST_PRIVATE_OFFER, REQUEST_A_DEMO,\n PROMOTIONAL_MEDIA, FREE_TRIAL, and\n QUICK_LAUNCH.
What you should do. It might contain a link to the console.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why the feature is recommended.
", "smithy.api#required": {} } }, "Severity": { "target": "com.amazonaws.marketplacecatalog#RecommendationSeverity", "traits": { "smithy.api#documentation": "How much the recommendation blocks the listing. Valid values are\n BLOCKING and ADVISORY.
Whether the listing has the feature. Valid values are:
\n\n PASS - The listing already has the feature.
\n FAIL - The feature is one to turn on.
A recommended AWS Marketplace feature for a listing.
" } }, "com.amazonaws.marketplacecatalog#FeatureRecommendationList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#FeatureRecommendation" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.marketplacecatalog#FeatureRecommendations": { "type": "structure", "members": { "Recommendations": { "target": "com.amazonaws.marketplacecatalog#FeatureRecommendationList", "traits": { "smithy.api#documentation": "The recommended features, in ranked order. The list has at most one entry for each\n feature and up to 5 entries.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The feature recommendations for a listing, for a product or a solution.
" } }, "com.amazonaws.marketplacecatalog#FieldName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-_\\.\\/]+$" } }, "com.amazonaws.marketplacecatalog#FieldText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5000 } } }, "com.amazonaws.marketplacecatalog#FieldTextItem": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.marketplacecatalog#FieldTextList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#FieldTextItem" }, "traits": { "smithy.api#length": { "min": 1, "max": 15 } } }, "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.
The question to answer.
", "smithy.api#required": {} } }, "Justification": { "target": "com.amazonaws.marketplacecatalog#FollowUpQuestionJustification", "traits": { "smithy.api#documentation": "Why the question is asked.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A question that you can answer to get a better recommendation, and the\n reason that it's asked.
" } }, "com.amazonaws.marketplacecatalog#FollowUpQuestionJustification": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5000 } } }, "com.amazonaws.marketplacecatalog#FollowUpQuestionList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#FollowUpQuestion" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.marketplacecatalog#FollowUpQuestionText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecatalog#FrameworkFilters": { "type": "union", "members": { "AMISecurityFilters": { "target": "com.amazonaws.marketplacecatalog#AMISecurityFilters", "traits": { "smithy.api#documentation": "Filters that apply to assessments performed against the AMI Security framework.
" } }, "ContainerSecurityFilters": { "target": "com.amazonaws.marketplacecatalog#ContainerSecurityFilters", "traits": { "smithy.api#documentation": "Filters that apply to assessments performed against the Container Security\n framework.
" } } }, "traits": { "smithy.api#documentation": "Framework-specific filters used to scope ListAssessments results. Set\n exactly one member, corresponding to the framework you want to filter by.
The details of the resource assessed under the AMI Security framework.
" } }, "ContainerSecuritySummary": { "target": "com.amazonaws.marketplacecatalog#ContainerSecuritySummary", "traits": { "smithy.api#documentation": "The details of the resource assessed under the Container Security framework.
" } }, "ListingQualitySummary": { "target": "com.amazonaws.marketplacecatalog#ListingQualitySummary", "traits": { "smithy.api#documentation": "The details of the resource assessed under the Listing Quality framework.
" } }, "ListingRecommendationsSummary": { "target": "com.amazonaws.marketplacecatalog#ListingRecommendationsSummary", "traits": { "smithy.api#documentation": "The details of the resource assessed under the Listing Recommendations framework.
" } } }, "traits": { "smithy.api#documentation": "The framework-specific details of the assessed resource. Exactly one member is set,\n corresponding to the framework that was assessed.
" } }, "com.amazonaws.marketplacecatalog#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#GetResourcePolicyResponse" }, "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": "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#Intent": { "type": "enum", "members": { "VALIDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATE" } }, "APPLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPLY" } } } }, "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#ListAssessments": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#ListAssessmentsRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#ListAssessmentsResponse" }, "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 a paginated list of assessments associated with an entity or change set in\n AWS Marketplace. An assessment is the result of evaluating a\n product or change set against a framework, such as AMI Security or Container\n Security.
\nUse the AssessmentTargetFilter to scope results to a specific entity or\n change set, and use FrameworkFilters to scope results to a single\n framework. To retrieve detailed control-level results for an individual assessment, use\n the DescribeAssessment action.
Results are sorted by assessment creation time in descending order.
", "smithy.api#http": { "method": "POST", "uri": "/ListAssessments", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "AssessmentSummaryList", "pageSize": "MaxResults" } } }, "com.amazonaws.marketplacecatalog#ListAssessmentsMaxResultInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.marketplacecatalog#ListAssessmentsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.marketplacecatalog#Catalog", "traits": { "smithy.api#documentation": "The catalog related to the request. Fixed value: AWSMarketplace\n
The unique identifier of a framework. When specified, only assessments performed\n against this framework are returned. For example, AMISecurity. Required\n when you use EntityIds in AssessmentTargetFilter.
Filters the list of assessments to those performed against a specific entity or\n change set.
" } }, "FrameworkFilters": { "target": "com.amazonaws.marketplacecatalog#FrameworkFilters", "traits": { "smithy.api#documentation": "Framework-specific filters. Set exactly one member to filter results to assessments\n performed against that framework.
" } }, "MaxResults": { "target": "com.amazonaws.marketplacecatalog#ListAssessmentsMaxResultInteger", "traits": { "smithy.api#default": 20, "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. Valid values range from 1 to 100.
" } }, "NextToken": { "target": "com.amazonaws.marketplacecatalog#NextToken", "traits": { "smithy.api#documentation": "The value of the next token, if it exists. null if there are no more\n results.
An array of AssessmentSummary objects.
The value of the next token, if it exists. null if there are no more\n results.
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: AmiProduct, ContainerProduct,\n DataProduct, SaaSProduct, ProcurementPolicy,\n Experience, Audience, BrandingSettings,\n Offer, OfferSet, Seller,\n ResaleAuthorization, Solution,\n SubsidiaryAuthorization.
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#ListingCaseStudy": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.marketplacecatalog#EntityId", "traits": { "smithy.api#documentation": "The ID of the case study entity. Identify a case study by this ID and not by\n Title, which you can edit.
The title of the case study.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this case study was selected.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A recommended case study.
" } }, "com.amazonaws.marketplacecatalog#ListingFinding": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.marketplacecatalog#RecommendedAction", "traits": { "smithy.api#documentation": "What you should do to meet the criterion.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.marketplacecatalog#FindingDescription", "traits": { "smithy.api#documentation": "What the criterion asks for. The text is the same for every listing. The reasoning\n for a specific listing is in the rationale of the alternatives.
", "smithy.api#required": {} } }, "Severity": { "target": "com.amazonaws.marketplacecatalog#RecommendationSeverity", "traits": { "smithy.api#documentation": "How much the criterion blocks the listing. It is set on every row. For a row with\n a status of PASS, it is the weight of a criterion that is already met.\n Valid values are BLOCKING and ADVISORY.
The result for the criterion. Valid values are:
\n\n PASS - The criterion is met and no action is needed.
\n FAIL - The criterion isn't met or wasn't scored.
This value is different from the status of the content recommendation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One row of the checklist of criteria for a listing field. A row is either a\n criterion that the field already meets or advice for a criterion that it doesn't.
" } }, "com.amazonaws.marketplacecatalog#ListingFindingStatus": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } } } }, "com.amazonaws.marketplacecatalog#ListingQualitySummary": { "type": "structure", "members": { "Tier": { "target": "com.amazonaws.marketplacecatalog#ListingQualityTier", "traits": { "smithy.api#documentation": "The quality tier of the listing. Valid values are NEEDS_IMPROVEMENT,\n BASIC, STRONG, and EXCELLENT.
The revision of the entity that the tier was evaluated against. To check whether the\n tier is out of date, compare this value with the current revision of the entity.
" } } }, "traits": { "smithy.api#documentation": "The details of the resource assessed under the Listing Quality framework.
" } }, "com.amazonaws.marketplacecatalog#ListingQualityTier": { "type": "enum", "members": { "NEEDS_IMPROVEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEEDS_IMPROVEMENT" } }, "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BASIC" } }, "STRONG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRONG" } }, "EXCELLENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXCELLENT" } } } }, "com.amazonaws.marketplacecatalog#ListingRecommendations": { "type": "union", "members": { "ProductContentRecommendations": { "target": "com.amazonaws.marketplacecatalog#ProductContentRecommendations", "traits": { "smithy.api#documentation": "The content recommendations for a product listing.
" } }, "SolutionContentRecommendations": { "target": "com.amazonaws.marketplacecatalog#SolutionContentRecommendations", "traits": { "smithy.api#documentation": "The content recommendations for a solution listing.
" } }, "FeatureRecommendations": { "target": "com.amazonaws.marketplacecatalog#FeatureRecommendations", "traits": { "smithy.api#documentation": "The recommendations for AWS Marketplace features to use with the listing, for a\n product or a solution.
" } } }, "traits": { "smithy.api#documentation": "The recommendations that a listing recommendations control produced. Exactly one\n member is set, corresponding to the control: content recommendations for a product,\n content recommendations for a solution, or feature recommendations.
" } }, "com.amazonaws.marketplacecatalog#ListingRecommendationsSummary": { "type": "structure", "members": { "Tier": { "target": "com.amazonaws.marketplacecatalog#ListingQualityTier", "traits": { "smithy.api#documentation": "The quality tier of the listing. Valid values are NEEDS_IMPROVEMENT,\n BASIC, STRONG, and EXCELLENT.
The revision of the entity that the recommendations were generated against. To check whether\n the recommendations are out of date, compare this value with the current revision of the\n entity.
" } } }, "traits": { "smithy.api#documentation": "The details of the resource assessed under the Listing Recommendations framework.
" } }, "com.amazonaws.marketplacecatalog#ListingUseCase": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.marketplacecatalog#UseCaseId", "traits": { "smithy.api#documentation": "The unique identifier of the use case.
", "smithy.api#required": {} } }, "Rank": { "target": "com.amazonaws.marketplacecatalog#UseCaseRank", "traits": { "smithy.api#documentation": "The rank of the use case. A rank of 1 is the strongest match. Valid values range\n from 1 to 5.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.marketplacecatalog#UseCaseTaxonomyValue", "traits": { "smithy.api#documentation": "The name of the use case.
", "smithy.api#required": {} } }, "Group": { "target": "com.amazonaws.marketplacecatalog#UseCaseTaxonomyValue", "traits": { "smithy.api#documentation": "The group of the use case in the taxonomy.
", "smithy.api#required": {} } }, "Subgroup": { "target": "com.amazonaws.marketplacecatalog#UseCaseTaxonomyValue", "traits": { "smithy.api#documentation": "The subgroup of the use case in the taxonomy.
", "smithy.api#required": {} } }, "UseCaseDetails": { "target": "com.amazonaws.marketplacecatalog#UseCaseDetails", "traits": { "smithy.api#documentation": "How the solution serves the use case.
" } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this use case is recommended.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A use case from the AWS Marketplace use case taxonomy.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductEntityIdFilterValueList", "traits": { "smithy.api#documentation": "A list of entity IDs to filter by. The operation returns machine learning products with entity IDs that match the values in this list.
" } } }, "traits": { "smithy.api#documentation": "The filter for machine learning product entity IDs.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductEntityIdFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductEntityIdString" }, "traits": { "smithy.api#documentation": "A list of entity ID values to filter by. You can include up to 10 entity IDs in this list.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#MachineLearningProductEntityIdString": { "type": "string", "traits": { "smithy.api#documentation": "The entity ID of a machine learning product. This string uniquely identifies the product.
", "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#MachineLearningProductFilters": { "type": "structure", "members": { "EntityId": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductEntityIdFilter", "traits": { "smithy.api#documentation": "Filter machine learning products by their entity IDs.
" } }, "LastModifiedDate": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductLastModifiedDateFilter", "traits": { "smithy.api#documentation": "Filter machine learning products by their last modified date.
" } }, "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductTitleFilter", "traits": { "smithy.api#documentation": "Filter machine learning products by their product titles.
" } }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityFilter", "traits": { "smithy.api#documentation": "Filter machine learning products by their visibility status.
" } } }, "traits": { "smithy.api#documentation": "The filters that you can use with the ListEntities operation to filter machine learning products. \n You can filter by EntityId, astModifiedDate, ProductTitle, and Visibility.
A date range to filter by. The operation returns machine learning products with last modified dates that fall within this range.
" } } }, "traits": { "smithy.api#documentation": "The filter for machine learning product last modified date.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The start date (inclusive) of the date range. The operation returns machine learning products with last modified dates on or after this date.
" } }, "BeforeValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The end date (inclusive) of the date range. The operation returns machine learning products with last modified dates on or before this date.
" } } }, "traits": { "smithy.api#documentation": "A date range for filtering machine learning products by their last modified date.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductSort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductSortBy", "traits": { "smithy.api#documentation": "The field to sort by. Valid values: EntityId, LastModifiedDate, ProductTitle, and Visibility.
The sort order. Valid values are ASC (ascending) and DESC (descending).
The sort options for machine learning products.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductSortBy": { "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" } } }, "traits": { "smithy.api#documentation": "The fields that you can sort machine learning products by.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductSummary": { "type": "structure", "members": { "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductTitleString", "traits": { "smithy.api#documentation": "The title of the machine learning product.
" } }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityString", "traits": { "smithy.api#documentation": "The visibility status of the machine learning product. Valid values are Limited, Public, Restricted, and Draft.
A summary of a machine learning product.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductTitleFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductTitleFilterValueList", "traits": { "smithy.api#documentation": "A list of product titles to filter by. The operation returns machine learning products with titles that exactly match the values in this list.
" } }, "WildCardValue": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductTitleString", "traits": { "smithy.api#documentation": "A wildcard value to filter product titles. The operation returns machine learning products with titles that match this wildcard pattern.
" } } }, "traits": { "smithy.api#documentation": "The filter for machine learning product titles.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductTitleFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductTitleString" }, "traits": { "smithy.api#documentation": "A list of product title values to filter by. You can include up to 10 product titles in this list.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#MachineLearningProductTitleString": { "type": "string", "traits": { "smithy.api#documentation": "The title of a machine learning product.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityFilterValueList", "traits": { "smithy.api#documentation": "A list of visibility values to filter by. The operation returns machine learning products with visibility status that match the values in this list.
" } } }, "traits": { "smithy.api#documentation": "The filter for machine learning product visibility status.
" } }, "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityString" }, "traits": { "smithy.api#documentation": "A list of visibility status values to filter by. You can include up to 10 visibility status values in this list.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#MachineLearningProductVisibilityString": { "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" } } }, "traits": { "smithy.api#documentation": "The visibility status of a machine learning product. Valid values are:
\n\n Limited - The product is available to a limited set of buyers.
\n Public - The product is publicly available to all buyers.
\n Restricted - The product has restricted availability.
\n Draft - The product is in draft state and not yet available to buyers.
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 the CreatedBySource of an offer with list input.
Allows filtering on the CreatedBySource 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 ResaleAuthorizationId of an offer.
Not all offers have a ResaleAuthorizationId. The response will only\n include offers for which you have permissions.
A filter that matches offers by the ID of the subsidiary authorization that they were created\n from.
\nNot all offers have a SubsidiaryAuthorizationId.
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 the OfferSetId of an offer.
Allows filtering on the TargetAgreementId of an offer.
Allows filtering on the TargetAgreementIntent of an offer.
Allows filtering on the CreatedBySource of an offer.
Object containing all the filter fields for offers entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.
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 filtering on the ResaleAuthorizationId of an offer with list input.
Allows filtering on the ResaleAuthorizationId of an offer.
Not all offers have a ResaleAuthorizationId. The response will only\n include offers for which you have permissions.
Allows filtering on the AssociatedOfferIds of an offer set with list input.
Allows filtering on the AssociatedOfferIds of an offer set.
Allows filtering on entity id of an offer set with list input.
" } } }, "traits": { "smithy.api#documentation": "Allows filtering on the entity id of an offer set.
" } }, "com.amazonaws.marketplacecatalog#OfferSetEntityIdFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#OfferSetEntityIdString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#OfferSetEntityIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^offerset-[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" } }, "com.amazonaws.marketplacecatalog#OfferSetFilters": { "type": "structure", "members": { "EntityId": { "target": "com.amazonaws.marketplacecatalog#OfferSetEntityIdFilter", "traits": { "smithy.api#documentation": "Allows filtering on EntityId of an offer set.
Allows filtering on the Name of an offer set.
Allows filtering on the State of an offer set.
Allows filtering on the ReleaseDate of an offer set.
Allows filtering on the AssociatedOfferIds of an offer set.
Allows filtering on the SolutionId of an offer set.
Allows filtering on the LastModifiedDate of an offer set.
Object containing all the filter fields for offer sets entity. Client can add a maximum of 8 filters in a single ListEntities request.
Allows filtering on the OfferSetId of an offer.
Allows filtering on the OfferSetId of an offer.
Allows filtering on the LastModifiedDate of an offer set with date range as input.
Allows filtering on the LastModifiedDate of an offer set.
Allows filtering on the LastModifiedDate of an offer set after a date.
Allows filtering on the LastModifiedDate of an offer set before a date.
Allows filtering on the LastModifiedDate of an offer set with date range as input.
Allows filtering on the Name of an offer set with list input.
Allows filtering on the Name of an offer set.
Allows filtering on the ReleaseDate of an offer set with date range as input.
Allows filtering on the ReleaseDate of an offer set.
Allows filtering on the ReleaseDate of offer set after a date.
Allows filtering on the ReleaseDate of offer set before a date.
Allows filtering on the ReleaseDate of an offer set with date range as input.
Allows filtering on the SolutionId of an offer set with list input.
Allows filtering on the SolutionId of an offer set.
Allows to sort offer sets.
" } }, "SortOrder": { "target": "com.amazonaws.marketplacecatalog#SortOrder", "traits": { "smithy.api#documentation": "Allows to sort offer sets.
" } } }, "traits": { "smithy.api#documentation": "Allows to sort offer sets.
" } }, "com.amazonaws.marketplacecatalog#OfferSetSortBy": { "type": "enum", "members": { "Name": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Name" } }, "State": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "State" } }, "ReleaseDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReleaseDate" } }, "SolutionId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SolutionId" } }, "EntityId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EntityId" } }, "LastModifiedDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } } } }, "com.amazonaws.marketplacecatalog#OfferSetStateFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#OfferSetStateFilterValueList", "traits": { "smithy.api#documentation": "Allows filtering on the State of an offer set with list input.
Allows filtering on the State of an offer set.
The name of the offer set.
" } }, "State": { "target": "com.amazonaws.marketplacecatalog#OfferSetStateString", "traits": { "smithy.api#documentation": "The state of the offer set.
" } }, "ReleaseDate": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The release date of the offer set.
" } }, "AssociatedOfferIds": { "target": "com.amazonaws.marketplacecatalog#OfferSetAssociatedOfferIdsList", "traits": { "smithy.api#documentation": "The list of offer IDs associated with the offer set.
" } }, "SolutionId": { "target": "com.amazonaws.marketplacecatalog#OfferSetSolutionIdString", "traits": { "smithy.api#documentation": "The solution ID associated with the offer set.
" } } }, "traits": { "smithy.api#documentation": "Summarized information about an offer set.
" } }, "com.amazonaws.marketplacecatalog#OfferSort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.marketplacecatalog#OfferSortBy", "traits": { "smithy.api#documentation": "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" } }, "ResaleAuthorizationId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResaleAuthorizationId" } }, "SubsidiaryAuthorizationId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SubsidiaryAuthorizationId" } }, "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" } }, "OfferSetId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OfferSetId" } }, "TargetAgreementId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetAgreementId" } }, "TargetAgreementIntent": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetAgreementIntent" } }, "CreatedBySource": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedBySource" } } } }, "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.
A list of subsidiary authorization IDs to filter offers by. You can include up to 10\n subsidiary authorization IDs in this list.
" } } }, "traits": { "smithy.api#documentation": "A filter that matches offers by the ID of the subsidiary authorization they were\n created from.
\nNot all offers have a SubsidiaryAuthorizationId.
The name of the offer.
" } }, "ProductId": { "target": "com.amazonaws.marketplacecatalog#OfferProductIdString", "traits": { "smithy.api#documentation": "The product ID of the offer.
" } }, "ResaleAuthorizationId": { "target": "com.amazonaws.marketplacecatalog#OfferResaleAuthorizationIdString", "traits": { "smithy.api#documentation": "The ResaleAuthorizationId of the offer.
" } }, "SubsidiaryAuthorizationId": { "target": "com.amazonaws.marketplacecatalog#OfferSubsidiaryAuthorizationIdString", "traits": { "smithy.api#documentation": "The ID of the subsidiary authorization that the offer was created from. The ID begins with\n subauthz- followed by 13 alphanumeric characters.
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.
" } }, "OfferSetId": { "target": "com.amazonaws.marketplacecatalog#OfferSetIdString", "traits": { "smithy.api#documentation": "The offer set ID of the offer.
" } }, "TargetAgreementId": { "target": "com.amazonaws.marketplacecatalog#OfferTargetAgreementIdString", "traits": { "smithy.api#documentation": "The target agreement ID of the offer.
" } }, "TargetAgreementIntent": { "target": "com.amazonaws.marketplacecatalog#OfferTargetAgreementIntentString", "traits": { "smithy.api#documentation": "The target agreement intent of the offer.
" } }, "CreatedBySource": { "target": "com.amazonaws.marketplacecatalog#OfferCreatedBySourceString", "traits": { "smithy.api#documentation": "The creation source of the offer.
" } } }, "traits": { "smithy.api#documentation": "Summarized information about an offer.
" } }, "com.amazonaws.marketplacecatalog#OfferTargetAgreementIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#OfferTargetAgreementIdFilterValueList", "traits": { "smithy.api#documentation": "Allows filtering on the TargetAgreementId of an offer with list input.
Allows filtering on the TargetAgreementId of an offer.
Allows filtering on the TargetAgreementIntent of an offer with list input.
Allows filtering on the TargetAgreementIntent of an offer.
Allows filtering on the Targeting of an offer with list input.
Allows filtering on the Targeting of an offer.
The recommendation for the product title.
" } }, "ShortDescription": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the short description.
" } }, "LongDescription": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the long description.
" } }, "SupportDescription": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the support description.
" } }, "Highlights": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the highlights.
" } }, "SearchKeywords": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the search keywords.
" } }, "Categories": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the categories.
" } }, "AdditionalResources": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the additional resources. Each alternative has up to 3\n resources.
" } }, "Citations": { "target": "com.amazonaws.marketplacecatalog#CitationList", "traits": { "smithy.api#documentation": "The sources that the recommendations are based on. You can have up to 5 sources.\n The list is empty if there are none.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The content recommendations for a product listing, with one member for each\n listing field. A member is absent if nothing is recommended for that field.
" } }, "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" }, { "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": {} } }, "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#Rationale": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.marketplacecatalog#RecommendationCitation": { "type": "structure", "members": { "Url": { "target": "com.amazonaws.marketplacecatalog#CitationUrl", "traits": { "smithy.api#documentation": "The HTTPS URL of the source.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A source that the recommendations are based on.
" } }, "com.amazonaws.marketplacecatalog#RecommendationSeverity": { "type": "enum", "members": { "BLOCKING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCKING" } }, "ADVISORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADVISORY" } } } }, "com.amazonaws.marketplacecatalog#RecommendedAction": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.marketplacecatalog#RecommendedFeatureId": { "type": "enum", "members": { "REQUEST_PRIVATE_OFFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUEST_PRIVATE_OFFER" } }, "REQUEST_A_DEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUEST_A_DEMO" } }, "PROMOTIONAL_MEDIA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROMOTIONAL_MEDIA" } }, "FREE_TRIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FREE_TRIAL" } }, "QUICK_LAUNCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUICK_LAUNCH" } } } }, "com.amazonaws.marketplacecatalog#RecommendedFeatureStatus": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } } } }, "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.
Allows filtering on the ResellerRole of a ResaleAuthorization.
Allows filtering on the SourceAuthorization of a ResaleAuthorization.
Allows filtering on the IssuerAccountId of a ResaleAuthorization.
Object containing all the filter fields for resale authorization entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.
Allows filtering on the IssuerAccountId of a ResaleAuthorization with list input.
Allows filtering on the IssuerAccountId of a ResaleAuthorization.
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#ResaleAuthorizationResellerRoleFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerRoleFilterValueList", "traits": { "smithy.api#documentation": "Allows filtering on the ResellerRole of a ResaleAuthorization with list input.
Allows filtering on the ResellerRole of a ResaleAuthorization.
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" } }, "ResellerRole": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResellerRole" } }, "SourceAuthorization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SourceAuthorization" } }, "IssuerAccountId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IssuerAccountId" } } } }, "com.amazonaws.marketplacecatalog#ResaleAuthorizationSourceAuthorizationFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationSourceAuthorizationFilterValueList", "traits": { "smithy.api#documentation": "Allows filtering on the SourceAuthorization of a ResaleAuthorization with list input.
Allows filtering on the SourceAuthorization of a ResaleAuthorization.
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.
" } }, "ResellerRole": { "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationResellerRoleString", "traits": { "smithy.api#documentation": "The reseller role of the ResaleAuthorization.
" } }, "SourceAuthorization": { "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationSourceAuthorizationString", "traits": { "smithy.api#documentation": "The source authorization of the ResaleAuthorization.
" } }, "IssuerAccountId": { "target": "com.amazonaws.marketplacecatalog#ResaleAuthorizationIssuerAccountIdString", "traits": { "smithy.api#documentation": "The issuer account ID 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#ResourceText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.marketplacecatalog#ResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.marketplacecatalog#ResourceUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "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": "Unique identifier for the SaaS product.
" } }, "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleFilter", "traits": { "smithy.api#documentation": "The title of the SaaS product.
" } }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilter", "traits": { "smithy.api#documentation": "The visibility of the SaaS product.
" } }, "LastModifiedDate": { "target": "com.amazonaws.marketplacecatalog#SaaSProductLastModifiedDateFilter", "traits": { "smithy.api#documentation": "The last date on which the SaaS product was modified.
" } } }, "traits": { "smithy.api#documentation": "Object containing all the filter fields for SaaS products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.
Dates between which the SaaS product was last modified.
" } } }, "traits": { "smithy.api#documentation": "Object that allows filtering based on the last modified date of SaaS products
" } }, "com.amazonaws.marketplacecatalog#SaaSProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "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#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 SaaS 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 SaaS products based on certain fields and sorting order.
" } }, "com.amazonaws.marketplacecatalog#SaaSProductSortBy": { "type": "enum", "members": { "EntityId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EntityId" } }, "ProductTitle": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ProductTitle" } }, "Visibility": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Visibility" } }, "LastModifiedDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } }, "DeliveryOptionTypes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeliveryOptionTypes" } } } }, "com.amazonaws.marketplacecatalog#SaaSProductSummary": { "type": "structure", "members": { "ProductTitle": { "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleString", "traits": { "smithy.api#documentation": "The title of the SaaS product.
" } }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityString", "traits": { "smithy.api#documentation": "The lifecycle of the SaaS product.
" } } }, "traits": { "smithy.api#documentation": "Object that contains summarized information about a SaaS product.
" } }, "com.amazonaws.marketplacecatalog#SaaSProductTitleFilter": { "type": "structure", "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#SaaSProductTitleFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SaaSProductTitleString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SaaSProductTitleString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilter": { "type": "structure", "members": { "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": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" } }, "com.amazonaws.marketplacecatalog#SaaSProductVisibilityFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SaaSProductVisibilityString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SaaSProductVisibilityString": { "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#ScopeName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.marketplacecatalog#ScopeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.marketplacecatalog#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" } }, "traits": { "smithy.api#documentation": "The maximum number of open requests per account has been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.marketplacecatalog#SolutionContentRecommendations": { "type": "structure", "members": { "Title": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the external title of the solution.
" } }, "ShortDescription": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the value proposition of the solution.
" } }, "LongDescription": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the long description of the solution.
" } }, "IntegrationDetails": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the integration details of the solution.
" } }, "AdditionalResources": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the additional resources. Each alternative has up to 8\n resources.
" } }, "UseCases": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the use cases of the solution.
" } }, "CaseStudies": { "target": "com.amazonaws.marketplacecatalog#ContentRecommendation", "traits": { "smithy.api#documentation": "The recommendation for the case studies of the solution. Each alternative has up\n to 20 case studies.
" } }, "Citations": { "target": "com.amazonaws.marketplacecatalog#CitationList", "traits": { "smithy.api#documentation": "The sources that the recommendations are based on. You can have up to 5 sources.\n The list is empty if there are none.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The content recommendations for a solution listing, with one member for each\n listing field. A member is absent if nothing is recommended for that field.
" } }, "com.amazonaws.marketplacecatalog#Sort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.marketplacecatalog#SortBy", "traits": { "smithy.api#documentation": "For ListEntities, supported attributes include\n LastModifiedDate (default) and EntityId. In addition to\n LastModifiedDate and EntityId, each\n EntityType might support additional fields.
For ListChangeSets, supported attributes include StartTime\n and EndTime.
The sorting order. Can be ASCENDING or DESCENDING. The\n default value is DESCENDING.
An object that contains two attributes, SortBy and\n SortOrder.
Starts an assessment of a product entity against a framework. An\n assessment is the result of evaluating an entity against the\n controls of a framework. You choose the controls to run and provide the input that each\n control needs.
\nThe assessment runs asynchronously. This action returns the ID of the assessment\n immediately. To get its status and the results of each control, use the\n DescribeAssessment action. To find assessments that you started earlier,\n use the ListAssessments action.
The catalog related to the request. Fixed value: AWSMarketplace\n
A unique token to identify the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } }, "FrameworkId": { "target": "com.amazonaws.marketplacecatalog#FrameworkId", "traits": { "smithy.api#documentation": "The unique identifier of the framework that defines the controls to run.
", "smithy.api#required": {} } }, "EntityId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { "smithy.api#documentation": "The unique ID of the product entity to assess.
", "smithy.api#required": {} } }, "Controls": { "target": "com.amazonaws.marketplacecatalog#ControlInputList", "traits": { "smithy.api#documentation": "The controls to provide input for. Every control in the framework is included in the\n assessment, and a control that you don't specify gets no input. You can specify\n 1\u2013100 controls.
" } }, "Tags": { "target": "com.amazonaws.marketplacecatalog#TagMap", "traits": { "smithy.api#documentation": "A map of tags to apply to the assessment when you create it. Each tag is a key-value\n pair. You can specify 1\u2013200 tags.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#StartAssessmentResponse": { "type": "structure", "members": { "AssessmentId": { "target": "com.amazonaws.marketplacecatalog#AssessmentIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the assessment that was started.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#StartChangeSet": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#StartChangeSetRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#StartChangeSetResponse" }, "errors": [ { "target": "com.amazonaws.marketplacecatalog#AccessDeniedException" }, { "target": "com.amazonaws.marketplacecatalog#InternalServiceException" }, { "target": "com.amazonaws.marketplacecatalog#ResourceInUseException" }, { "target": "com.amazonaws.marketplacecatalog#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacecatalog#ServiceQuotaExceededException" }, { "target": "com.amazonaws.marketplacecatalog#ThrottlingException" }, { "target": "com.amazonaws.marketplacecatalog#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows you to request changes for your entities. Within a single\n ChangeSet, you can't start the same change type against the same entity\n multiple times. Additionally, when a ChangeSet is running, all the entities\n targeted by the different changes are locked until the change set has completed (either\n succeeded, cancelled, or failed). If you try to start a change set containing a change\n against an entity that is already locked, you will receive a\n 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\n change type (AddRevisions) against the same entity\n (entity-id@1).
For more information about working with change sets, see Working with change sets. For information about change types for\n single-AMI products, see Working with single-AMI products. Also, for more information about change\n types available for container-based products, see Working with container products.
\nTo download \"DetailsDocument\" shapes, see Python \n and Java shapes on GitHub.
", "smithy.api#http": { "method": "POST", "uri": "/StartChangeSet", "code": 200 } } }, "com.amazonaws.marketplacecatalog#StartChangeSetRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.marketplacecatalog#Catalog", "traits": { "smithy.api#documentation": "The catalog related to the request. Fixed value: AWSMarketplace\n
Array of change object.
Optional case sensitive string of up to 100 ASCII characters. The change set name can\n be used to filter the list of change sets.
" } }, "ClientRequestToken": { "target": "com.amazonaws.marketplacecatalog#ClientRequestToken", "traits": { "smithy.api#documentation": "A unique token to identify the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } }, "ChangeSetTags": { "target": "com.amazonaws.marketplacecatalog#TagList", "traits": { "smithy.api#documentation": "A list of objects specifying each key name and value for the\n ChangeSetTags property.
The intent related to the request. The default is APPLY.\n To test your request before applying changes to your entities, use VALIDATE.\n This feature is currently available for adding versions to single-AMI products. For more information, see\n Add a new version.
Unique identifier generated for the request.
" } }, "ChangeSetArn": { "target": "com.amazonaws.marketplacecatalog#ARN", "traits": { "smithy.api#documentation": "The ARN associated to the unique identifier generated for the request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationCreatedDateFilter": { "type": "structure", "members": { "DateRange": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationCreatedDateFilterDateRange", "traits": { "smithy.api#documentation": "A date range to filter by. The operation returns subsidiary authorizations with creation dates\n that fall within this range.
" } } }, "traits": { "smithy.api#documentation": "The filter for the date a subsidiary authorization was created.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationCreatedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The start date (inclusive) of the date range. The operation returns subsidiary authorizations\n created on or after this date.
" } }, "BeforeValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The end date (inclusive) of the date range. The operation returns subsidiary authorizations\n created on or before this date.
" } } }, "traits": { "smithy.api#documentation": "A date range for filtering subsidiary authorizations by creation date.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationEntityIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationEntityIdFilterValueList", "traits": { "smithy.api#documentation": "A list of entity IDs to filter by. The operation returns subsidiary authorizations with an\n entity ID that matches any value in this list. You can include up to 10 entity IDs in\n this list.
" } } }, "traits": { "smithy.api#documentation": "The filter for subsidiary authorization entity IDs. Each ID begins with subauthz-\n followed by 13 alphanumeric characters.
A filter that matches subsidiary authorizations by entity ID.
" } }, "Status": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationStatusFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by status.
" } }, "ResourceId": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceIdFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by the ID of the authorized resource.
" } }, "ResourceName": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by the name of the authorized resource.
" } }, "Name": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by name.
" } }, "SubsidiaryAccountId": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSubsidiaryAccountIdFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by the AWS account ID of the subsidiary\n account.
" } }, "CreatedDate": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationCreatedDateFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by creation date.
" } }, "LastModifiedDate": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationLastModifiedDateFilter", "traits": { "smithy.api#documentation": "A filter that matches subsidiary authorizations by last modified date.
" } } }, "traits": { "smithy.api#documentation": "The filters that you can use with the ListEntities operation to filter subsidiary\n authorizations. You can filter by EntityId, Status,\n ResourceId, ResourceName, Name,\n SubsidiaryAccountId, CreatedDate, and\n LastModifiedDate. You can add only one wildcard filter in a single\n ListEntities request.
A date range to filter by. The operation returns subsidiary authorizations with last modified\n dates that fall within this range.
" } } }, "traits": { "smithy.api#documentation": "The filter for the date a subsidiary authorization was last modified.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The start date (inclusive) of the date range. The operation returns subsidiary authorizations\n last modified on or after this date.
" } }, "BeforeValue": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The end date (inclusive) of the date range. The operation returns subsidiary authorizations\n last modified on or before this date.
" } } }, "traits": { "smithy.api#documentation": "A date range for filtering subsidiary authorizations by last modified date.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameFilterValueList", "traits": { "smithy.api#documentation": "A list of names to filter by. The operation returns subsidiary authorizations with a name that\n matches any value in this list. You can include up to 10 names in this list.
" } }, "WildCardValue": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameFilterWildcard", "traits": { "smithy.api#documentation": "A partial name to filter by. The operation returns subsidiary authorizations whose\n name contains this value. The value must be at least 3 characters.
" } } }, "traits": { "smithy.api#documentation": "The filter for subsidiary authorization names.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameFilterWildcard": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceIdFilterValueList", "traits": { "smithy.api#documentation": "A list of resource IDs to filter by. The operation returns subsidiary authorizations for\n resources with an ID that matches any value in this list. You can include up to 10\n resource IDs in this list.
" } } }, "traits": { "smithy.api#documentation": "The filter for the IDs of resources that subsidiary authorizations apply to.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceIdFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceIdString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameFilterValueList", "traits": { "smithy.api#documentation": "A list of resource names to filter by. The operation returns subsidiary authorizations for\n resources with a name that matches any value in this list. You can include up to 10\n resource names in this list.
" } }, "WildCardValue": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameFilterWildcard", "traits": { "smithy.api#documentation": "A partial resource name to filter by. The operation returns subsidiary authorizations\n for resources whose name contains this value. The value must be at least 3\n characters.
" } } }, "traits": { "smithy.api#documentation": "The filter for the names of resources that subsidiary authorizations apply to.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameFilterWildcard": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationResourceNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSortBy", "traits": { "smithy.api#documentation": "The field to sort subsidiary authorizations by. Valid values are EntityId,\n Status, ResourceId, SubsidiaryAccountId,\n CreatedDate, and LastModifiedDate.
The sorting order. Can be ASCENDING or DESCENDING. The\n default value is DESCENDING.
Specifies the field to sort subsidiary authorizations by and the order (ascending or\n descending) to apply.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSortBy": { "type": "enum", "members": { "EntityId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EntityId" } }, "Status": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Status" } }, "ResourceId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceId" } }, "SubsidiaryAccountId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SubsidiaryAccountId" } }, "CreatedDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedDate" } }, "LastModifiedDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationStatusFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationStatusFilterValueList", "traits": { "smithy.api#documentation": "A list of statuses to filter by. The operation returns subsidiary authorizations with a status\n that matches a value in this list. Valid values are:
\n\n Draft - The subsidiary authorization was created but not yet released.\n The subsidiary account can't see it.
\n Active - The subsidiary account can use the subsidiary authorization to\n create offers for the authorized product.
\n Restricted - The subsidiary authorization was discarded while in\n Draft or revoked while Active. It can't be used to create new\n offers. This status is final.
The filter for subsidiary authorization statuses.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationStatusFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationStatusString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationStatusString": { "type": "enum", "members": { "Draft": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Draft" } }, "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Restricted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Restricted" } } }, "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSubsidiaryAccountIdFilter": { "type": "structure", "members": { "ValueList": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSubsidiaryAccountIdFilterValueList", "traits": { "smithy.api#documentation": "A list of AWS account IDs to filter by. The operation returns subsidiary authorizations whose\n subsidiary account ID matches any value in this list. You can include up to 10 account\n IDs in this list.
" } } }, "traits": { "smithy.api#documentation": "The filter for the AWS account IDs of subsidiary accounts.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSubsidiaryAccountIdFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSubsidiaryAccountIdString" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSubsidiaryAccountIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummary": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummaryNameString", "traits": { "smithy.api#documentation": "The name of the subsidiary authorization.
" } }, "Status": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummaryStatusString", "traits": { "smithy.api#documentation": "The status of the subsidiary authorization. Valid values are:
\n\n Draft - The subsidiary authorization was created but not yet released.\n The subsidiary account can't see it.
\n Active - The subsidiary account can use the subsidiary authorization to\n create offers for the authorized product.
\n Restricted - The subsidiary authorization was discarded while in\n Draft or revoked while Active. It can't be used to create new\n offers. This status is final.
The ID of the resource that the subsidiary authorization applies to. Currently, this is always\n a product ID, such as prod-example123.
The name of the resource that the subsidiary authorization applies to. Currently, this is\n always a product name.
" } }, "SubsidiaryAccountId": { "target": "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummarySubsidiaryAccountIdString", "traits": { "smithy.api#documentation": "The 12-digit AWS account ID of the subsidiary account.
" } }, "CreatedDate": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { "smithy.api#documentation": "The date the subsidiary authorization was created.
" } } }, "traits": { "smithy.api#documentation": "An object that contains summary information about a subsidiary authorization, including its\n name, status, authorized resource, subsidiary account, and creation date. A subsidiary\n authorization lets a seller authorize one of its subsidiary accounts to create offers\n for one of its products.
" } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummaryNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummaryResourceIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummaryResourceNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummaryStatusString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.marketplacecatalog#SubsidiaryAuthorizationSummarySubsidiaryAccountIdString": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.marketplacecatalog#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.marketplacecatalog#TagKey", "traits": { "smithy.api#documentation": "The key associated with the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.marketplacecatalog#TagValue", "traits": { "smithy.api#documentation": "The value associated with the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A list of objects specifying each key name and value.
" } }, "com.amazonaws.marketplacecatalog#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.marketplacecatalog#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.marketplacecatalog#TagList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.marketplacecatalog#TagMap": { "type": "map", "key": { "target": "com.amazonaws.marketplacecatalog#TagKey" }, "value": { "target": "com.amazonaws.marketplacecatalog#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.marketplacecatalog#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#TagResourceRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#TagResourceResponse" }, "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": "Tags a resource (either an entity or change set).
", "smithy.api#http": { "method": "POST", "uri": "/TagResource", "code": 200 } } }, "com.amazonaws.marketplacecatalog#TagResourceRequest": { "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\n tag.
", "smithy.api#required": {} } }, "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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.marketplacecatalog#TextAlternative": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.marketplacecatalog#FieldText", "traits": { "smithy.api#documentation": "The proposed text. The limit of the field itself, such as 255 characters for a\n title, applies.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this alternative is recommended.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A proposed text value for a listing field.
" } }, "com.amazonaws.marketplacecatalog#TextAlternativeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#TextAlternative" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.marketplacecatalog#TextListAlternative": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.marketplacecatalog#FieldTextList", "traits": { "smithy.api#documentation": "The proposed list of text values. The list has 1\u201315 items.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this alternative is recommended.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A proposed list of text values for a listing field.
" } }, "com.amazonaws.marketplacecatalog#TextListAlternativeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#TextListAlternative" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.marketplacecatalog#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" } }, "traits": { "smithy.api#documentation": "Too many requests.
\nHTTP status code: 429
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.marketplacecatalog#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecatalog#UntagResourceRequest" }, "output": { "target": "com.amazonaws.marketplacecatalog#UntagResourceResponse" }, "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": "Removes a tag or list of tags from a resource (either an entity or change set).
", "smithy.api#http": { "method": "POST", "uri": "/UntagResource", "code": 200 } } }, "com.amazonaws.marketplacecatalog#UntagResourceRequest": { "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\n remove the tag from.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.marketplacecatalog#TagKeyList", "traits": { "smithy.api#documentation": "Required. A list of key names of tags to be removed. Number of strings allowed:\n 0-256.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacecatalog#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacecatalog#UseCaseDetails": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.marketplacecatalog#UseCaseId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.marketplacecatalog#UseCaseList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ListingUseCase" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.marketplacecatalog#UseCaseRank": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 5 } } }, "com.amazonaws.marketplacecatalog#UseCaseTaxonomyValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.marketplacecatalog#UseCasesAlternative": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.marketplacecatalog#UseCaseList", "traits": { "smithy.api#documentation": "The proposed use cases, in ranked order.
", "smithy.api#required": {} } }, "Rationale": { "target": "com.amazonaws.marketplacecatalog#Rationale", "traits": { "smithy.api#documentation": "Why this alternative is recommended.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A proposed set of use cases for a solution.
" } }, "com.amazonaws.marketplacecatalog#UseCasesAlternativeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#UseCasesAlternative" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.marketplacecatalog#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.marketplacecatalog#ExceptionMessageContent" }, "ValidationExceptionFieldList": { "target": "com.amazonaws.marketplacecatalog#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "A list of detailed entries describing the request fields that failed\n validation. Present when the failure can be attributed to one or more specific\n fields.
" } } }, "traits": { "smithy.api#documentation": "An error occurred during validation.
\nHTTP status code: 422
", "smithy.api#error": "client", "smithy.api#httpError": 422 } }, "com.amazonaws.marketplacecatalog#ValidationExceptionField": { "type": "structure", "members": { "Reason": { "target": "com.amazonaws.marketplacecatalog#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason the field failed validation.
" } }, "EntityType": { "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { "smithy.api#documentation": "The entity type the failing field applies to, if the field is on a\n specific entity. For example, AmiProduct@1.0.
The entity identifier the failing field applies to, if the field is on a\n specific entity.
" } }, "ChangeType": { "target": "com.amazonaws.marketplacecatalog#ChangeType", "traits": { "smithy.api#documentation": "The change type the failing field applies to, if the field is part of a\n change request. For example, AddDeliveryOptions.
The name of the request field that failed validation, expressed as a\n JSON path (for example, Details.DeliveryOptions[0].Type).
A human-readable message describing why the field failed\n validation.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about a single request field that failed\n validation, including the field's location, the reason it failed, and a\n human-readable message.
" } }, "com.amazonaws.marketplacecatalog#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#ValidationExceptionField" } }, "com.amazonaws.marketplacecatalog#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UnknownOperation" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CannotParse" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FieldValidationFailed" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Other" } } } }, "com.amazonaws.marketplacecatalog#ValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacecatalog#FilterValueContent" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacecatalog#VerificationSource": { "type": "enum", "members": { "AWS_VERIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_VERIFIED" } }, "SELF_ATTESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELF_ATTESTED" } } } }, "com.amazonaws.marketplacecatalog#VersionedFrameworkId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-@.]+$" } }, "com.amazonaws.marketplacecatalog#VisibilityValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z]+$" } } } }