{ "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.marketplaceentitlementservice#AWSMPEntitlementService": { "type": "service", "version": "2017-01-11", "operations": [ { "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlements" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Entitlement Service", "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceEntitlementService", "cloudTrailEventSource": "marketplaceentitlementservice.amazonaws.com", "docId": "entitlement.marketplace-2017-01-11", "endpointPrefix": "entitlement.marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "AWS Marketplace Entitlement Service\n

This reference provides descriptions of the AWS Marketplace Entitlement Service\n API.

\n

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to\n a given product. An entitlement represents capacity in a product owned by the customer. For\n example, a customer might own some number of users or seats in an SaaS application or some\n amount of data capacity in a multi-tenant database.

\n

\n Getting Entitlement Records\n

\n ", "smithy.api#title": "AWS Marketplace Entitlement Service", "smithy.protocols#rpcv2Cbor": {}, "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": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] } ], "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://entitlement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://entitlement-marketplace.{Region}.amazonaws.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://entitlement-marketplace.{Region}.amazonaws.eu", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://entitlement.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://entitlement.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://entitlement.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://entitlement.marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 17, "nodes": "/////wAAAAH/////AAAAAAAAABAAAAADAAAAAQAAAAQF9eEOAAAAAgAAAAUF9eEOAAAAAwAAAAwAAAAGAAAABQAAAAsAAAAHAAAABgAAAAkAAAAIAAAACQX14QYF9eENAAAABwX14QQAAAAKAAAACAX14QsF9eEMAAAABgX14QQF9eEFAAAABAAAAA4AAAANAAAABgX14QgF9eEKAAAABgAAAA8F9eEJAAAACAX14QcF9eEIAAAAAwX14QEAAAARAAAABgX14QIF9eED" }, "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": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://entitlement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://entitlement-marketplace.{Region}.amazonaws.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://entitlement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://entitlement-marketplace.{Region}.amazonaws.eu", "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://entitlement.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://entitlement.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://entitlement.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://entitlement.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 enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://entitlement.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://entitlement.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 enabled", "expect": { "endpoint": { "url": "https://entitlement-marketplace.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://entitlement.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://entitlement.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://entitlement.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://entitlement-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://entitlement-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://entitlement.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://entitlement-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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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://entitlement.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.marketplaceentitlementservice#Boolean": { "type": "boolean" }, "com.amazonaws.marketplaceentitlementservice#Double": { "type": "double" }, "com.amazonaws.marketplaceentitlementservice#Entitlement": { "type": "structure", "members": { "ProductCode": { "target": "com.amazonaws.marketplaceentitlementservice#ProductCode", "traits": { "smithy.api#documentation": "

The product code for which the given entitlement applies. Product codes are provided by\n AWS Marketplace when the product listing is created.

" } }, "Dimension": { "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", "traits": { "smithy.api#documentation": "

The dimension for which the given entitlement applies. Dimensions represent categories of\n capacity in a product and are specified when the product is listed in AWS\n Marketplace.

" } }, "CustomerIdentifier": { "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", "traits": { "smithy.api#documentation": "

The customer identifier is a handle to each unique customer in an application. Customer\n identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering\n Service.

" } }, "CustomerAWSAccountId": { "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", "traits": { "smithy.api#documentation": "

\n The CustomerAWSAccountId parameter specifies the AWS account ID of the buyer.\n

" } }, "Value": { "target": "com.amazonaws.marketplaceentitlementservice#EntitlementValue", "traits": { "smithy.api#documentation": "

The EntitlementValue represents the amount of capacity that the customer is entitled to\n for the product.

" } }, "ExpirationDate": { "target": "com.amazonaws.marketplaceentitlementservice#Timestamp", "traits": { "smithy.api#documentation": "

The expiration date represents the minimum date through which this entitlement is\n expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date\n is the date at which the customer will renew or cancel their contract. Customers who are opting\n to renew their contract will still have entitlements with an expiration date.

" } }, "LicenseArn": { "target": "com.amazonaws.marketplaceentitlementservice#String", "traits": { "smithy.api#documentation": "

The LicenseArn is a unique identifier for a specific granted license. These are used for software purchased through AWS Marketplace.

" } } }, "traits": { "smithy.api#documentation": "

An entitlement represents capacity in a product owned by the customer. For example, a\n customer might own some number of users or seats in an SaaS application or some amount of\n data capacity in a multi-tenant database.

" } }, "com.amazonaws.marketplaceentitlementservice#EntitlementList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceentitlementservice#Entitlement" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.marketplaceentitlementservice#EntitlementValue": { "type": "structure", "members": { "IntegerValue": { "target": "com.amazonaws.marketplaceentitlementservice#Integer", "traits": { "smithy.api#documentation": "

The IntegerValue field will be populated with an integer value when the entitlement is an\n integer type. Otherwise, the field will not be set.

" } }, "DoubleValue": { "target": "com.amazonaws.marketplaceentitlementservice#Double", "traits": { "smithy.api#documentation": "

The DoubleValue field will be populated with a double value when the entitlement is a\n double type. Otherwise, the field will not be set.

" } }, "BooleanValue": { "target": "com.amazonaws.marketplaceentitlementservice#Boolean", "traits": { "smithy.api#documentation": "

The BooleanValue field will be populated with a boolean value when the entitlement is a\n boolean type. Otherwise, the field will not be set.

" } }, "StringValue": { "target": "com.amazonaws.marketplaceentitlementservice#String", "traits": { "smithy.api#documentation": "

The StringValue field will be populated with a string value when the entitlement is a\n string type. Otherwise, the field will not be set.

" } } }, "traits": { "smithy.api#documentation": "

The EntitlementValue represents the amount of capacity that the customer is entitled to\n for the product.

" } }, "com.amazonaws.marketplaceentitlementservice#ErrorMessage": { "type": "string" }, "com.amazonaws.marketplaceentitlementservice#FilterValue": { "type": "string" }, "com.amazonaws.marketplaceentitlementservice#FilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplaceentitlementservice#FilterValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilterName": { "type": "enum", "members": { "CUSTOMER_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_IDENTIFIER" } }, "DIMENSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIMENSION" } }, "CUSTOMER_AWS_ACCOUNT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_AWS_ACCOUNT_ID" } }, "LICENSE_ARN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LICENSE_ARN" } } } }, "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilters": { "type": "map", "key": { "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilterName" }, "value": { "target": "com.amazonaws.marketplaceentitlementservice#FilterValueList" } }, "com.amazonaws.marketplaceentitlementservice#GetEntitlements": { "type": "operation", "input": { "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementsRequest" }, "output": { "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementsResult" }, "errors": [ { "target": "com.amazonaws.marketplaceentitlementservice#InternalServiceErrorException" }, { "target": "com.amazonaws.marketplaceentitlementservice#InvalidParameterException" }, { "target": "com.amazonaws.marketplaceentitlementservice#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

GetEntitlements retrieves entitlement values for a given product. The results can be\n filtered based on customer identifier, AWS account ID, license ARN, or product dimensions.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.marketplaceentitlementservice#GetEntitlementsRequest": { "type": "structure", "members": { "ProductCode": { "target": "com.amazonaws.marketplaceentitlementservice#ProductCode", "traits": { "smithy.api#documentation": "

Product code is used to uniquely identify a product in AWS Marketplace. The product code\n will be provided by AWS Marketplace when the product listing is created.

", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilters", "traits": { "smithy.api#documentation": "

Filter is used to return entitlements for a specific customer or for a specific\n dimension. Filters are described as keys mapped to a lists of values. Filtered requests are\n unioned for each value in the value list, and then\n intersected for each filter key.

\n

\n CustomerIdentifier and CustomerAWSAccountId are mutually exclusive parameters. You must use one or the other, but not both in the same request.\n

\n \n

If you're migrating an existing integration, use Account Feeds to map CustomerIdentifier to CustomerAWSAccountId, and Agreements Feeds to map CustomerAWSAccountId and LicenseArn.

\n
" } }, "NextToken": { "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", "traits": { "smithy.api#documentation": "

For paginated calls to GetEntitlements, pass the NextToken from the previous\n GetEntitlementsResult.

" } }, "MaxResults": { "target": "com.amazonaws.marketplaceentitlementservice#PageSizeInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to retrieve from the GetEntitlements operation. For\n pagination, use the NextToken field in subsequent calls to GetEntitlements.

" } } }, "traits": { "smithy.api#documentation": "

The GetEntitlementsRequest contains parameters for the GetEntitlements\n operation.

", "smithy.api#input": {} } }, "com.amazonaws.marketplaceentitlementservice#GetEntitlementsResult": { "type": "structure", "members": { "Entitlements": { "target": "com.amazonaws.marketplaceentitlementservice#EntitlementList", "traits": { "smithy.api#documentation": "

The set of entitlements found through the GetEntitlements operation. If the result\n contains an empty set of entitlements, NextToken might still be present and should be\n used.

" } }, "NextToken": { "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", "traits": { "smithy.api#documentation": "

For paginated results, use NextToken in subsequent calls to GetEntitlements. If the\n result contains an empty set of entitlements, NextToken might still be present and should be\n used.

" } } }, "traits": { "smithy.api#documentation": "

The GetEntitlementsRequest contains results from the GetEntitlements operation.

", "smithy.api#output": {} } }, "com.amazonaws.marketplaceentitlementservice#Integer": { "type": "integer" }, "com.amazonaws.marketplaceentitlementservice#InternalServiceErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplaceentitlementservice#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

An internal error has occurred. Retry your request. If the problem persists, post a\n message with details on the AWS forums.

", "smithy.api#error": "server" } }, "com.amazonaws.marketplaceentitlementservice#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplaceentitlementservice#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

One or more parameters in your request was invalid.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplaceentitlementservice#NonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.marketplaceentitlementservice#PageSizeInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.marketplaceentitlementservice#ProductCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplaceentitlementservice#String": { "type": "string" }, "com.amazonaws.marketplaceentitlementservice#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplaceentitlementservice#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The calls to the GetEntitlements API are throttled.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplaceentitlementservice#Timestamp": { "type": "timestamp" } } }