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: AWS Marketplace

  • clientToken (string) –

    The idempotency token for deployment parameters. A unique identifier for the new version.

    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.ThrottlingException

  • MarketplaceDeploymentService.Client.exceptions.AccessDeniedException

  • MarketplaceDeploymentService.Client.exceptions.ResourceNotFoundException

  • MarketplaceDeploymentService.Client.exceptions.ServiceQuotaExceededException

  • MarketplaceDeploymentService.Client.exceptions.ConflictException

  • MarketplaceDeploymentService.Client.exceptions.ValidationException

  • MarketplaceDeploymentService.Client.exceptions.InternalServerException