Proton / Client / get_resources_summary

get_resources_summary#

Proton.Client.get_resources_summary()#

Get counts of Proton resources.

For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it’s behind the recommended version of the Proton template that it uses and it needs an update to become current.

The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the components, environments, and serviceTemplates field descriptions.

For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.

For more information, see Proton dashboard in the Proton User Guide.

Request Syntax

response = client.get_resources_summary()

Return type:

dict

Returns:

Response Syntax

{
    'counts': {
        'components': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        },
        'environmentTemplates': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        },
        'environments': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        },
        'pipelines': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        },
        'serviceInstances': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        },
        'serviceTemplates': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        },
        'services': {
            'behindMajor': 123,
            'behindMinor': 123,
            'failed': 123,
            'total': 123,
            'upToDate': 123
        }
    }
}

Response Structure

(dict) –
- counts (dict) –
  
  Summary counts of each Proton resource type.
  - components (dict) –
    
    The total number of components in the Amazon Web Services account.
    
    The semantics of the components field are different from the semantics of results for other infrastructure-provisioning resources. That’s because at this time components don’t have associated templates, therefore they don’t have the concept of staleness. The components object will only contain total and failed members.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
  - environmentTemplates (dict) –
    
    The total number of environment templates in the Amazon Web Services account. The environmentTemplates object will only contain total members.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
  - environments (dict) –
    
    The staleness counts for Proton environments in the Amazon Web Services account. The environments object will only contain total members.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
  - pipelines (dict) –
    
    The staleness counts for Proton pipelines in the Amazon Web Services account.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
  - serviceInstances (dict) –
    
    The staleness counts for Proton service instances in the Amazon Web Services account.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
  - serviceTemplates (dict) –
    
    The total number of service templates in the Amazon Web Services account. The serviceTemplates object will only contain total members.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
  - services (dict) –
    
    The staleness counts for Proton services in the Amazon Web Services account.
    - behindMajor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a major template version update.
    - behindMinor (integer) –
      
      The number of resources of this type in the Amazon Web Services account that need a minor template version update.
    - failed (integer) –
      
      The number of resources of this type in the Amazon Web Services account that failed to deploy.
    - total (integer) –
      
      The total number of resources of this type in the Amazon Web Services account.
    - upToDate (integer) –
      
      The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.InternalServerException