:doc:`MarketplaceDeploymentService <../../marketplace-deployment>` / Client / put_deployment_parameter

************************
put_deployment_parameter
************************



.. py:method:: MarketplaceDeploymentService.Client.put_deployment_parameter(**kwargs)

  

  Creates or updates a deployment parameter and is targeted by ``catalog`` and ``agreementId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/marketplace-deployment-2023-01-25/PutDeploymentParameter>`_  


  **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'
        }
    )
    
  :type agreementId: string
  :param agreementId: **[REQUIRED]** 

    The unique identifier of the agreement.

    

  
  :type catalog: string
  :param catalog: **[REQUIRED]** 

    The catalog related to the request. Fixed value: ``AWSMarketplace``

    

  
  :type clientToken: string
  :param clientToken: 

    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.

  
  :type deploymentParameter: dict
  :param deploymentParameter: **[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.

      

    
  
  :type expirationDate: datetime
  :param expirationDate: 

    The date when deployment parameters expire and are scheduled for deletion.

    

  
  :type productId: string
  :param productId: **[REQUIRED]** 

    The product for which AWS Marketplace will save secrets for the buyer’s account.

    

  
  :type tags: dict
  :param tags: 

    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) --* 

      


  
  :rtype: 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**
  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.ConflictException`

  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.ValidationException`

  
  *   :py:class:`MarketplaceDeploymentService.Client.exceptions.InternalServerException`

  