MarketplaceDeploymentService **************************** Client ====== class MarketplaceDeploymentService.Client A low-level client representing AWS Marketplace Deployment Service 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 products. 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. import boto3 client = boto3.client('marketplace-deployment') These are the available methods: * can_paginate * close * get_paginator * get_waiter * list_tags_for_resource * put_deployment_parameter * tag_resource * untag_resource MarketplaceDeploymentService / Client / get_paginator get_paginator ************* MarketplaceDeploymentService.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. MarketplaceDeploymentService / Client / can_paginate can_paginate ************ MarketplaceDeploymentService.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. MarketplaceDeploymentService / Client / list_tags_for_resource list_tags_for_resource ********************** MarketplaceDeploymentService.Client.list_tags_for_resource(**kwargs) Lists all tags that have been added to a deployment parameter resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) associated with the deployment parameter resource you want to list tags on. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A map of key-value pairs, where each pair represents a tag present on the resource. * *(string) --* * *(string) --* **Exceptions** * "MarketplaceDeploymentService.Client.exceptions.ThrottlingExcept ion" * "MarketplaceDeploymentService.Client.exceptions.AccessDeniedExce ption" * "MarketplaceDeploymentService.Client.exceptions.ResourceNotFound Exception" * "MarketplaceDeploymentService.Client.exceptions.ValidationExcept ion" * "MarketplaceDeploymentService.Client.exceptions.InternalServerEx ception" MarketplaceDeploymentService / Client / untag_resource untag_resource ************** MarketplaceDeploymentService.Client.untag_resource(**kwargs) Removes a tag or list of tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from. * **tagKeys** (*list*) -- **[REQUIRED]** A list of key names of tags to be removed. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MarketplaceDeploymentService.Client.exceptions.ThrottlingExcept ion" * "MarketplaceDeploymentService.Client.exceptions.AccessDeniedExce ption" * "MarketplaceDeploymentService.Client.exceptions.ResourceNotFound Exception" * "MarketplaceDeploymentService.Client.exceptions.ConflictExceptio n" * "MarketplaceDeploymentService.Client.exceptions.ValidationExcept ion" * "MarketplaceDeploymentService.Client.exceptions.InternalServerEx ception" MarketplaceDeploymentService / Client / get_waiter get_waiter ********** MarketplaceDeploymentService.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" MarketplaceDeploymentService / Client / close close ***** MarketplaceDeploymentService.Client.close() Closes underlying endpoint connections. MarketplaceDeploymentService / Client / tag_resource tag_resource ************ MarketplaceDeploymentService.Client.tag_resource(**kwargs) Tags a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) associated with the resource you want to tag. * **tags** (*dict*) -- A map of key-value pairs, where each pair represents a tag present on the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MarketplaceDeploymentService.Client.exceptions.ThrottlingExcept ion" * "MarketplaceDeploymentService.Client.exceptions.AccessDeniedExce ption" * "MarketplaceDeploymentService.Client.exceptions.ResourceNotFound Exception" * "MarketplaceDeploymentService.Client.exceptions.ConflictExceptio n" * "MarketplaceDeploymentService.Client.exceptions.ValidationExcept ion" * "MarketplaceDeploymentService.Client.exceptions.InternalServerEx ception" MarketplaceDeploymentService / Client / put_deployment_parameter put_deployment_parameter ************************ MarketplaceDeploymentService.Client.put_deployment_parameter(**kwargs) Creates or updates a deployment parameter and is targeted by "catalog" and "agreementId". See also: AWS API Documentation **Request Syntax** response = client.put_deployment_parameter( agreementId='string', catalog='string', clientToken='string', deploymentParameter={ 'name': 'string', 'secretString': 'string' }, expirationDate=datetime(2015, 1, 1), productId='string', tags={ 'string': 'string' } ) Parameters: * **agreementId** (*string*) -- **[REQUIRED]** The unique identifier of the agreement. * **catalog** (*string*) -- **[REQUIRED]** The catalog related to the request. Fixed value: "AWSMarketplace" * **clientToken** (*string*) -- The idempotency token for deployment parameters. A unique identifier for the new version. Note: This field is not required if you're calling using an AWS SDK. Otherwise, a "clientToken" must be provided with the request. This field is autopopulated if not provided. * **deploymentParameter** (*dict*) -- **[REQUIRED]** The deployment parameter targeted to the acceptor of an agreement for which to create the AWS Secret Manager resource. * **name** *(string) --* **[REQUIRED]** 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. * **secretString** *(string) --* **[REQUIRED]** The text to encrypt and store in the secret. * **expirationDate** (*datetime*) -- The date when deployment parameters expire and are scheduled for deletion. * **productId** (*string*) -- **[REQUIRED]** The product for which AWS Marketplace will save secrets for the buyer’s account. * **tags** (*dict*) -- 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. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'agreementId': 'string', 'deploymentParameterId': 'string', 'resourceArn': 'string', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **agreementId** *(string) --* The unique identifier of the agreement. * **deploymentParameterId** *(string) --* The unique identifier of the deployment parameter. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) associated with the deployment parameter resource you want to create or update. * **tags** *(dict) --* 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. * *(string) --* * *(string) --* **Exceptions** * "MarketplaceDeploymentService.Client.exceptions.ThrottlingExcept ion" * "MarketplaceDeploymentService.Client.exceptions.AccessDeniedExce ption" * "MarketplaceDeploymentService.Client.exceptions.ResourceNotFound Exception" * "MarketplaceDeploymentService.Client.exceptions.ServiceQuotaExce ededException" * "MarketplaceDeploymentService.Client.exceptions.ConflictExceptio n" * "MarketplaceDeploymentService.Client.exceptions.ValidationExcept ion" * "MarketplaceDeploymentService.Client.exceptions.InternalServerEx ception"