:doc:`MarketplaceCatalog <../../marketplace-catalog>` / Client / describe_change_set

*******************
describe_change_set
*******************



.. py:method:: MarketplaceCatalog.Client.describe_change_set(**kwargs)

  

  Provides information about a given change set.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeChangeSet>`_  


  **Request Syntax**
  ::

    response = client.describe_change_set(
        Catalog='string',
        ChangeSetId='string'
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

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

    

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

    Required. The unique identifier for the ``StartChangeSet`` request that you want to describe the details for.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ChangeSetId': 'string',
          'ChangeSetArn': 'string',
          'ChangeSetName': 'string',
          'Intent': 'VALIDATE'|'APPLY',
          'StartTime': 'string',
          'EndTime': 'string',
          'Status': 'PREPARING'|'APPLYING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
          'FailureCode': 'CLIENT_ERROR'|'SERVER_FAULT',
          'FailureDescription': 'string',
          'ChangeSet': [
              {
                  'ChangeType': 'string',
                  'Entity': {
                      'Type': 'string',
                      'Identifier': 'string'
                  },
                  'Details': 'string',
                  'DetailsDocument': {...}|[...]|123|123.4|'string'|True|None,
                  'ErrorDetailList': [
                      {
                          'ErrorCode': 'string',
                          'ErrorMessage': 'string'
                      },
                  ],
                  'ChangeName': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ChangeSetId** *(string) --* 

        Required. The unique identifier for the change set referenced in this request.

        
      

      - **ChangeSetArn** *(string) --* 

        The ARN associated with the unique identifier for the change set referenced in this request.

        
      

      - **ChangeSetName** *(string) --* 

        The optional name provided in the ``StartChangeSet`` request. If you do not provide a name, one is set by default.

        
      

      - **Intent** *(string) --* 

        The optional intent provided in the ``StartChangeSet`` request. If you do not provide an intent, ``APPLY`` is set by default.

        
      

      - **StartTime** *(string) --* 

        The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.

        
      

      - **EndTime** *(string) --* 

        The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state.

        
      

      - **Status** *(string) --* 

        The status of the change request.

        
      

      - **FailureCode** *(string) --* 

        Returned if the change set is in ``FAILED`` status. Can be either ``CLIENT_ERROR``, which means that there are issues with the request (see the ``ErrorDetailList``), or ``SERVER_FAULT``, which means that there is a problem in the system, and you should retry your request.

        
      

      - **FailureDescription** *(string) --* 

        Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.

        
      

      - **ChangeSet** *(list) --* 

        An array of ``ChangeSummary`` objects.

        
        

        - *(dict) --* 

          This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.

          
          

          - **ChangeType** *(string) --* 

            The type of the change.

            
          

          - **Entity** *(dict) --* 

            The entity to be changed.

            
            

            - **Type** *(string) --* 

              The type of entity.

              
            

            - **Identifier** *(string) --* 

              The identifier for the entity.

              
        
          

          - **Details** *(string) --* 

            This object contains details specific to the change type of the requested change.

            
          

          - **DetailsDocument** (:ref:`document<document>`) -- 

            The JSON value of the details specific to the change type of the requested change.

             

            To download the "DetailsDocument" shapes, see the `Python <https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python>`__ and `Java <https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main>`__ shapes on GitHub.

            
          

          - **ErrorDetailList** *(list) --* 

            An array of ``ErrorDetail`` objects associated with the change.

            
            

            - *(dict) --* 

              Details about the error.

              
              

              - **ErrorCode** *(string) --* 

                The error code that identifies the type of error.

                
              

              - **ErrorMessage** *(string) --* 

                The message for the error.

                
          
        
          

          - **ChangeName** *(string) --* 

            Optional name for the change.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.InternalServiceException`

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

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

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

  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.ThrottlingException`

  