DevOpsGuru / Client / get_resource_collection

get_resource_collection#

DevOpsGuru.Client.get_resource_collection(**kwargs)#

Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Request Syntax

response = client.get_resource_collection(
    ResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_TAGS',
    NextToken='string'
)

Parameters:

ResourceCollectionType (string) –
[REQUIRED]

The type of Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks.
NextToken (string) – The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceCollection': {
        'CloudFormation': {
            'StackNames': [
                'string',
            ]
        },
        'Tags': [
            {
                'AppBoundaryKey': 'string',
                'TagValues': [
                    'string',
                ]
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

(dict) –
- ResourceCollection (dict) –
  
  The requested list of Amazon Web Services resource collections. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
  - CloudFormation (dict) –
    
    Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
    - StackNames (list) –
      
      An array of CloudFormation stack names.
      - (string) –
  - Tags (list) –
    
    The Amazon Web Services tags used to filter the resources in the resource collection.
    
    Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
    
    Each Amazon Web Services tag has two parts.
    - A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
    - An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
    Together these are known as key-value pairs.
    
    Warning
    The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
    - (dict) –
      
      A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from only resources that contain the tags in the tag collection.
      - AppBoundaryKey (string) –
        
        An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
        
        Warning
        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
      - TagValues (list) –
        
        The values in an Amazon Web Services tag collection.
        
        The tag’s value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag’s key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
        
        (string) –
- NextToken (string) –
  
  The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

DevOpsGuru.Client.exceptions.AccessDeniedException
DevOpsGuru.Client.exceptions.InternalServerException
DevOpsGuru.Client.exceptions.ResourceNotFoundException
DevOpsGuru.Client.exceptions.ThrottlingException
DevOpsGuru.Client.exceptions.ValidationException