:doc:`Proton <../../proton>` / Client / list_components

***************
list_components
***************



.. py:method:: Proton.Client.list_components(**kwargs)

  

  List components with summary data. You can filter the result list by environment, service, or a single service instance.

   

  For more information about components, see `Proton components <https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html>`__ in the *Proton User Guide*.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponents>`_  


  **Request Syntax**
  ::

    response = client.list_components(
        environmentName='string',
        maxResults=123,
        nextToken='string',
        serviceInstanceName='string',
        serviceName='string'
    )
    
  :type environmentName: string
  :param environmentName: 

    The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of components to list.

    

  
  :type nextToken: string
  :param nextToken: 

    A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

    

  
  :type serviceInstanceName: string
  :param serviceInstanceName: 

    The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

    

  
  :type serviceName: string
  :param serviceName: 

    The name of a service for result list filtering. Proton returns components attached to service instances of the service.

    

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

    
    ::

      {
          'components': [
              {
                  'arn': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
                  'deploymentStatusMessage': 'string',
                  'environmentName': 'string',
                  'lastAttemptedDeploymentId': 'string',
                  'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
                  'lastDeploymentSucceededAt': datetime(2015, 1, 1),
                  'lastModifiedAt': datetime(2015, 1, 1),
                  'lastSucceededDeploymentId': 'string',
                  'name': 'string',
                  'serviceInstanceName': 'string',
                  'serviceName': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **components** *(list) --* 

        An array of components with summary data.

        
        

        - *(dict) --* 

          Summary data of an Proton component resource.

           

          For more information about components, see `Proton components <https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html>`__ in the *Proton User Guide*.

          
          

          - **arn** *(string) --* 

            The Amazon Resource Name (ARN) of the component.

            
          

          - **createdAt** *(datetime) --* 

            The time when the component was created.

            
          

          - **deploymentStatus** *(string) --* 

            The component deployment status.

            
          

          - **deploymentStatusMessage** *(string) --* 

            The message associated with the component deployment status.

            
          

          - **environmentName** *(string) --* 

            The name of the Proton environment that this component is associated with.

            
          

          - **lastAttemptedDeploymentId** *(string) --* 

            The ID of the last attempted deployment of this component.

            
          

          - **lastDeploymentAttemptedAt** *(datetime) --* 

            The time when a deployment of the component was last attempted.

            
          

          - **lastDeploymentSucceededAt** *(datetime) --* 

            The time when the component was last deployed successfully.

            
          

          - **lastModifiedAt** *(datetime) --* 

            The time when the component was last modified.

            
          

          - **lastSucceededDeploymentId** *(string) --* 

            The ID of the last successful deployment of this component.

            
          

          - **name** *(string) --* 

            The name of the component.

            
          

          - **serviceInstanceName** *(string) --* 

            The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

            
          

          - **serviceName** *(string) --* 

            The name of the service that ``serviceInstanceName`` is associated with. Provided when a component is attached to a service instance.

            
      
    
      

      - **nextToken** *(string) --* 

        A token that indicates the location of the next component in the array of components, after the current requested list of components.

        
  
  **Exceptions**
  
  *   :py:class:`Proton.Client.exceptions.ValidationException`

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

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

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

  