{ "smithy": "2.0", "shapes": { "com.amazonaws.marketplacedeployment#AWSMPDeploymentParametersService": { "type": "service", "version": "2023-01-25", "operations": [ { "target": "com.amazonaws.marketplacedeployment#GetDeploymentConfigurationJob" }, { "target": "com.amazonaws.marketplacedeployment#ListDeploymentConfigurationJobs" }, { "target": "com.amazonaws.marketplacedeployment#ListTagsForResource" }, { "target": "com.amazonaws.marketplacedeployment#StartDeploymentConfigurationJob" }, { "target": "com.amazonaws.marketplacedeployment#TagResource" }, { "target": "com.amazonaws.marketplacedeployment#UntagResource" } ], "resources": [ { "target": "com.amazonaws.marketplacedeployment#DeploymentConfiguration" }, { "target": "com.amazonaws.marketplacedeployment#DeploymentParameter" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Deployment", "arnNamespace": "aws-marketplace", "endpointPrefix": "deployment-marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "
The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a product. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as API keys and external IDs, to buyers during the Quick Launch experience.
You can also use the AWS Marketplace Deployment Service to publish deployment configurations. A deployment configuration defines how buyers access a product's delivery option after they subscribe. For example, for the Data as a Service delivery option, it specifies the seller's fulfillment URL.
", "smithy.api#title": "AWS Marketplace Deployment Service", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "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" } }, "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": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, 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://deployment-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://deployment-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://deployment-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://deployment-marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "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" } }, "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": "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://deployment-marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "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 ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://deployment-marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://deployment-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://deployment-marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://deployment-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://deployment-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://deployment-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://deployment-marketplace.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://deployment-marketplace-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://deployment-marketplace-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://deployment-marketplace.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://deployment-marketplace.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://deployment-marketplace-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://deployment-marketplace-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://deployment-marketplace.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://deployment-marketplace.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://deployment-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://deployment-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://deployment-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://deployment-marketplace.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.marketplacedeployment#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.marketplacedeployment#Catalog": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z_-]+$" } }, "com.amazonaws.marketplacedeployment#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9/_+=.:@-]+$" } }, "com.amazonaws.marketplacedeployment#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.marketplacedeployment#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier for the resource associated with the error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request configuration has conflicts. For details, see the accompanying error message.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.marketplacedeployment#DataAsAServiceConfigurationDetail": { "type": "structure", "members": { "fulfillmentUrl": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationFulfillmentUrl", "traits": { "smithy.api#documentation": "The HTTPS URL that AWS Marketplace redirects buyers to after they subscribe to the product. The value must be a valid URI that uses the HTTPS scheme. Maximum length: 2,048 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.
" } }, "com.amazonaws.marketplacedeployment#DeliveryOptionType": { "type": "enum", "members": { "DATA_AS_A_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The Data as a Service delivery option.
", "smithy.api#enumValue": "data-as-a-service" } } }, "traits": { "smithy.api#documentation": "The delivery option type of a deployment configuration.
" } }, "com.amazonaws.marketplacedeployment#DeploymentConfiguration": { "type": "resource", "identifiers": { "catalog": { "target": "com.amazonaws.marketplacedeployment#Catalog" }, "productId": { "target": "com.amazonaws.marketplacedeployment#ResourceId" }, "deliveryOptionType": { "target": "com.amazonaws.marketplacedeployment#DeliveryOptionType" } }, "read": { "target": "com.amazonaws.marketplacedeployment#GetDeploymentConfiguration" }, "traits": { "aws.api#arn": { "template": "DeploymentConfiguration:catalogs/{catalog}/products/{productId}/delivery-options/{deliveryOptionType}" } } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationDetail": { "type": "union", "members": { "dataAsAService": { "target": "com.amazonaws.marketplacedeployment#DataAsAServiceConfigurationDetail", "traits": { "smithy.api#documentation": "The deployment configuration settings for the Data as a Service delivery option, including the fulfillment URL that AWS Marketplace redirects buyers to after they subscribe.
" } } }, "traits": { "smithy.api#documentation": "The deployment configuration. Exactly one member must be set, and it must match the delivery option type.
" } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationFulfillmentUrl": { "type": "string", "traits": { "smithy.api#documentation": "An HTTPS URL that conforms to RFC 3986.
", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobErrorCode": { "type": "enum", "members": { "FULFILLMENT_URL_UNREACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "AWS Marketplace couldn't reach the fulfillment URL when it validated the deployment configuration. The URL returned no HTTP response, for example because of a Domain Name System (DNS) failure, a refused connection, an untrusted or mismatched Transport Layer Security (TLS) certificate, or a timeout. Verify that the fulfillment URL is publicly reachable over HTTPS and responding, and then start a new job.
", "smithy.api#enumValue": "FULFILLMENT_URL_UNREACHABLE" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "An internal error occurred. Start a new job.
", "smithy.api#enumValue": "INTERNAL_ERROR" } }, "ENDPOINT_INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The fulfillment URL isn't a valid absolute HTTPS URL, or it points to a network location that AWS Marketplace doesn't allow, such as a private or loopback address. Correct the fulfillment URL, and then start a new job. A new job with the same URL fails again.
", "smithy.api#enumValue": "ENDPOINT_INVALID" } } }, "traits": { "smithy.api#documentation": "The error code that describes why a deployment configuration job failed.
" } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job is running.
", "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job finished, and its configuration is now the active deployment configuration.
", "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job failed. The active deployment configuration didn't change. For details, see errorCode and message.
The status of a deployment configuration job.
" } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobSummaries": { "type": "list", "member": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobSummary" } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobSummary": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobId", "traits": { "smithy.api#documentation": "The unique identifier of the deployment configuration job.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobStatus", "traits": { "smithy.api#documentation": "The status of the deployment configuration job.
", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationDetail", "traits": { "smithy.api#documentation": "The deployment configuration submitted with the job.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the job was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "Contains summary information about a deployment configuration job, including its identifier, status, configuration, and creation time.
" } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.marketplacedeployment#DeploymentConfigurationNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.marketplacedeployment#DeploymentParameter": { "type": "resource", "identifiers": { "catalog": { "target": "com.amazonaws.marketplacedeployment#Catalog" }, "productId": { "target": "com.amazonaws.marketplacedeployment#ResourceId" }, "deploymentParameterId": { "target": "com.amazonaws.marketplacedeployment#DeploymentParameterResourceIdentifier" } }, "create": { "target": "com.amazonaws.marketplacedeployment#PutDeploymentParameter" }, "traits": { "aws.api#arn": { "template": "DeploymentParameter:catalogs/{catalog}/products/{productId}/{deploymentParameterId}" } } }, "com.amazonaws.marketplacedeployment#DeploymentParameterInput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.marketplacedeployment#DeploymentParameterName", "traits": { "smithy.api#documentation": "The desired name of the deployment parameter. This is the identifier on which deployment parameters are keyed for a given buyer and product. If this name matches an existing deployment parameter, this request will update the existing resource.
", "smithy.api#required": {} } }, "secretString": { "target": "com.amazonaws.marketplacedeployment#SecretString", "traits": { "smithy.api#documentation": "The text to encrypt and store in the secret.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The shape containing the requested deployment parameter name and secretString.
To support AWS CloudFormation dynamic references to this resource using Quick Launch, this value must match a parameter defined in the CloudFormation template provided to buyers.
Returns the active deployment configuration for a product and delivery option. The active deployment configuration is the configuration from the most recent successful deployment configuration job. The seller that owns the product and buyers entitled to the product can call this operation.
If the product and delivery option have no active deployment configuration, the operation returns a ResourceNotFoundException.
Returns the details of a deployment configuration job. Only the seller that started the job can call this operation.
If the job doesn't belong to the product and delivery option in the request path, the operation returns a ResourceNotFoundException.
The catalog related to the request. Fixed value: AWSMarketplace
The ID of the AWS Marketplace product, for example prod-1234567890abc.
The delivery option type of the deployment configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobId", "traits": { "smithy.api#documentation": "The unique identifier of the deployment configuration job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacedeployment#GetDeploymentConfigurationJobResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobId", "traits": { "smithy.api#documentation": "The unique identifier of the deployment configuration job.
", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationDetail", "traits": { "smithy.api#documentation": "The deployment configuration submitted with the job.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobStatus", "traits": { "smithy.api#documentation": "The status of the deployment configuration job.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the job was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "configurationArn": { "target": "com.amazonaws.marketplacedeployment#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment configuration. This field is present only when the job status is SUCCEEDED.
The date and time when the job reached the SUCCEEDED or FAILED status.
The error code that describes why the job failed. This field is present only when the job status is FAILED.
A message that describes why the job failed. This field is present only when the job status is FAILED.
The catalog related to the request. Fixed value: AWSMarketplace
The ID of the AWS Marketplace product, for example prod-1234567890abc.
The delivery option type of the deployment configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacedeployment#GetDeploymentConfigurationResponse": { "type": "structure", "members": { "configuration": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationDetail", "traits": { "smithy.api#documentation": "The active deployment configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "There was an internal service exception.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.marketplacedeployment#ListDeploymentConfigurationJobs": { "type": "operation", "input": { "target": "com.amazonaws.marketplacedeployment#ListDeploymentConfigurationJobsRequest" }, "output": { "target": "com.amazonaws.marketplacedeployment#ListDeploymentConfigurationJobsResponse" }, "errors": [ { "target": "com.amazonaws.marketplacedeployment#AccessDeniedException" }, { "target": "com.amazonaws.marketplacedeployment#InternalServerException" }, { "target": "com.amazonaws.marketplacedeployment#ThrottlingException" }, { "target": "com.amazonaws.marketplacedeployment#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the deployment configuration jobs that you started for a product and delivery option, ordered from newest to oldest. Results are paginated. Use the nextToken parameter to retrieve additional results.
If you haven't started any jobs for the product and delivery option, the operation returns an empty jobs list.
The catalog related to the request. Fixed value: AWSMarketplace
The ID of the AWS Marketplace product, for example prod-1234567890abc.
The delivery option type of the deployment configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationMaxResults", "traits": { "smithy.api#default": 20, "smithy.api#documentation": "The maximum number of jobs to return in a single page. Valid values are 1 through 100. The default is 20.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationNextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. Use the value returned in the previous response.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacedeployment#ListDeploymentConfigurationJobsResponse": { "type": "structure", "members": { "jobs": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobSummaries", "traits": { "smithy.api#documentation": "A list of deployment configuration job summaries, ordered from newest to oldest.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationNextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. This value is absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.marketplacedeployment#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.marketplacedeployment#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.marketplacedeployment#AccessDeniedException" }, { "target": "com.amazonaws.marketplacedeployment#InternalServerException" }, { "target": "com.amazonaws.marketplacedeployment#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacedeployment#ThrottlingException" }, { "target": "com.amazonaws.marketplacedeployment#ValidationException" } ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list all tags on a DeploymentParameter or DeploymentConfiguration resource", "smithy.api#documentation": "Lists all tags that have been added to a resource.
", "smithy.api#examples": [ { "title": "Listing tags for a deployment parameter", "documentation": "The following example demonstrates listing the tags for a deployment parameter. If no tags are present, the API will return an empty map.", "input": { "resourceArn": "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier" }, "output": { "tags": { "FooKey": "BarValue", "HelloKey": "WorldValue" } } } ], "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.marketplacedeployment#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to list tags on.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacedeployment#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.marketplacedeployment#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs, where each pair represents a tag present on the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#PutDeploymentParameter": { "type": "operation", "input": { "target": "com.amazonaws.marketplacedeployment#PutDeploymentParameterRequest" }, "output": { "target": "com.amazonaws.marketplacedeployment#PutDeploymentParameterResponse" }, "errors": [ { "target": "com.amazonaws.marketplacedeployment#AccessDeniedException" }, { "target": "com.amazonaws.marketplacedeployment#ConflictException" }, { "target": "com.amazonaws.marketplacedeployment#InternalServerException" }, { "target": "com.amazonaws.marketplacedeployment#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacedeployment#ServiceQuotaExceededException" }, { "target": "com.amazonaws.marketplacedeployment#ThrottlingException" }, { "target": "com.amazonaws.marketplacedeployment#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates a deployment parameter and is targeted by catalog and agreementId.
The catalog related to the request. Fixed value: AWSMarketplace
The product for which AWS Marketplace will save secrets for the buyer\u2019s account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplacedeployment#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
", "smithy.api#required": {} } }, "deploymentParameter": { "target": "com.amazonaws.marketplacedeployment#DeploymentParameterInput", "traits": { "smithy.api#documentation": "The deployment parameter targeted to the acceptor of an agreement for which to create the AWS Secrets Manager resource.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.marketplacedeployment#TagsMap", "traits": { "smithy.api#documentation": "A map of key-value pairs, where each pair represents a tag saved to the resource. Tags will only be applied for create operations, and they'll be ignored if the resource already exists.
" } }, "expirationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date when deployment parameters expire and are scheduled for deletion.
", "smithy.api#timestampFormat": "date-time" } }, "clientToken": { "target": "com.amazonaws.marketplacedeployment#ClientToken", "traits": { "smithy.api#documentation": "The idempotency token for deployment parameters. A unique identifier for the new version.
This field is not required if you're calling using an AWS SDK. Otherwise, a clientToken must be provided with the request.
The Amazon Resource Name (ARN) associated with the deployment parameter resource you want to create or update.
", "smithy.api#required": {} } }, "agreementId": { "target": "com.amazonaws.marketplacedeployment#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier of the agreement.
", "smithy.api#required": {} } }, "deploymentParameterId": { "target": "com.amazonaws.marketplacedeployment#DeploymentParameterResourceIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the deployment parameter.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.marketplacedeployment#TagsMap", "traits": { "smithy.api#documentation": "A map of key-value pairs, where each pair represents a tag saved to the resource. Tags will only be applied for create operations, and they'll be ignored if the resource already exists.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[a-zA-Z0-9:*/-]+$" } }, "com.amazonaws.marketplacedeployment#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_/-]+$" } }, "com.amazonaws.marketplacedeployment#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The specified resource wasn't found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.marketplacedeployment#SecretString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 15000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.marketplacedeployment#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The maximum number of requests per account has been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.marketplacedeployment#StartDeploymentConfigurationJob": { "type": "operation", "input": { "target": "com.amazonaws.marketplacedeployment#StartDeploymentConfigurationJobRequest" }, "output": { "target": "com.amazonaws.marketplacedeployment#StartDeploymentConfigurationJobResponse" }, "errors": [ { "target": "com.amazonaws.marketplacedeployment#AccessDeniedException" }, { "target": "com.amazonaws.marketplacedeployment#ConflictException" }, { "target": "com.amazonaws.marketplacedeployment#InternalServerException" }, { "target": "com.amazonaws.marketplacedeployment#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacedeployment#ThrottlingException" }, { "target": "com.amazonaws.marketplacedeployment#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts a job that publishes a deployment configuration for a product and delivery option. The job runs asynchronously. Use GetDeploymentConfigurationJob to track its status. When the job reaches the SUCCEEDED status, its configuration becomes the active deployment configuration for the product and delivery option.
The populated member of configuration must match the deliveryOptionType in the request path.
The catalog related to the request. Fixed value: AWSMarketplace
The ID of the AWS Marketplace product, for example prod-1234567890abc.
The delivery option type of the deployment configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationDetail", "traits": { "smithy.api#documentation": "The deployment configuration to publish.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.marketplacedeployment#TagsMap", "traits": { "smithy.api#documentation": "A map of key-value pairs, where each pair represents a tag to apply to the deployment configuration. Only the request that creates the deployment configuration can apply tags. If the deployment configuration already exists, a request that includes one or more tags fails with a ValidationException. To change tags on an existing deployment configuration, use TagResource and UntagResource.
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry a request with the same token and the same input, the service returns the original job instead of starting a new one. If you reuse a token with different input, the request fails with a ConflictException.
This field is not required if you're calling using an AWS SDK. Otherwise, a clientToken must be provided with the request.
The unique identifier of the deployment configuration job.
", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationDetail", "traits": { "smithy.api#documentation": "The deployment configuration submitted with the job.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.marketplacedeployment#DeploymentConfigurationJobStatus", "traits": { "smithy.api#documentation": "The status of the deployment configuration job. The value is IN_PROGRESS.
The date and time when the job was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.marketplacedeployment#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9/_+=.:@-]+$" } }, "com.amazonaws.marketplacedeployment#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.marketplacedeployment#TagResourceRequest" }, "output": { "target": "com.amazonaws.marketplacedeployment#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.marketplacedeployment#AccessDeniedException" }, { "target": "com.amazonaws.marketplacedeployment#ConflictException" }, { "target": "com.amazonaws.marketplacedeployment#InternalServerException" }, { "target": "com.amazonaws.marketplacedeployment#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacedeployment#ThrottlingException" }, { "target": "com.amazonaws.marketplacedeployment#ValidationException" } ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to add or overwrite one or more tags for the specified DeploymentParameter or DeploymentConfiguration resource", "smithy.api#documentation": "Tags a resource.
", "smithy.api#examples": [ { "title": "Adding tags to a deployment parameter", "documentation": "The following example demonstrates adding two tags to a deployment parameter. There is no output from this API.", "input": { "resourceArn": "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier", "tags": { "FooKey": "BarValue", "HelloKey": "WorldValue" } }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 204 } } }, "com.amazonaws.marketplacedeployment#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource you want to tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.marketplacedeployment#Tags", "traits": { "smithy.api#documentation": "A map of key-value pairs, where each pair represents a tag present on the resource.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacedeployment#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9/_+=.:@-]+$" } }, "com.amazonaws.marketplacedeployment#Tags": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.marketplacedeployment#TagsMap": { "type": "map", "key": { "target": "com.amazonaws.marketplacedeployment#TagKey" }, "value": { "target": "com.amazonaws.marketplacedeployment#TagValue" }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.marketplacedeployment#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Too many requests.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.marketplacedeployment#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.marketplacedeployment#UntagResourceRequest" }, "output": { "target": "com.amazonaws.marketplacedeployment#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.marketplacedeployment#AccessDeniedException" }, { "target": "com.amazonaws.marketplacedeployment#ConflictException" }, { "target": "com.amazonaws.marketplacedeployment#InternalServerException" }, { "target": "com.amazonaws.marketplacedeployment#ResourceNotFoundException" }, { "target": "com.amazonaws.marketplacedeployment#ThrottlingException" }, { "target": "com.amazonaws.marketplacedeployment#ValidationException" } ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to disassociate one or more tags from the specified DeploymentParameter or DeploymentConfiguration resource", "smithy.api#documentation": "Removes a tag or list of tags from a resource.
", "smithy.api#examples": [ { "title": "Removing tags from a deployment parameter", "documentation": "The following example demonstrates removing two tags from a deployment parameter. For each, both the tag and the associated value are removed. There is no output from this API.", "input": { "resourceArn": "arn:aws:aws-marketplace:us-east-1:123456789012:DeploymentParameter:catalogs/AWSMarketplace/products/product-1234/dp-uniqueidentifier", "tagKeys": [ "FooKey", "HelloKey" ] }, "output": {} } ], "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.marketplacedeployment#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.marketplacedeployment#StringList", "traits": { "smithy.api#documentation": "A list of key names of tags to be removed.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacedeployment#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacedeployment#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "fieldName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The field name associated with the error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An error occurred during validation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } }