DevOpsGuru / Client / list_events

list_events#

DevOpsGuru.Client.list_events(**kwargs)#

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

Request Syntax

response = client.list_events(
    Filters={
        'InsightId': 'string',
        'EventTimeRange': {
            'FromTime': datetime(2015, 1, 1),
            'ToTime': datetime(2015, 1, 1)
        },
        'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
        'EventSource': 'string',
        'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
        'ResourceCollection': {
            'CloudFormation': {
                'StackNames': [
                    'string',
                ]
            },
            'Tags': [
                {
                    'AppBoundaryKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        }
    },
    MaxResults=123,
    NextToken='string',
    AccountId='string'
)

Parameters:

Filters (dict) –
[REQUIRED]

A ListEventsFilters object used to specify which events to return.
- InsightId (string) –
  
  An ID of an insight that is related to the events you want to filter for.
- EventTimeRange (dict) –
  
  A time range during which you want the filtered events to have occurred.
  - FromTime (datetime) – [REQUIRED]
    
    The time when the event started.
  - ToTime (datetime) – [REQUIRED]
    
    The time when the event ended.
- EventClass (string) –
  
  The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.
- EventSource (string) –
  
  The Amazon Web Services source that emitted the events you want to filter for.
- DataSource (string) –
  
  The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.
- ResourceCollection (dict) –
  
  A collection of Amazon Web Services resources supported by DevOps Guru. 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) –
    
    An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.
    - StackNames (list) –
      
      An array of CloudFormation stack names.
      - (string) –
  - Tags (list) –
    
    The Amazon Web Services tags that are used by 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.
      
      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.
      - AppBoundaryKey (string) – [REQUIRED]
        
        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) – [REQUIRED]
        
        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) –
MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
AccountId (string) – The ID of the Amazon Web Services account.

Return type:

dict

Returns:

Response Syntax

{
    'Events': [
        {
            'ResourceCollection': {
                'CloudFormation': {
                    'StackNames': [
                        'string',
                    ]
                },
                'Tags': [
                    {
                        'AppBoundaryKey': 'string',
                        'TagValues': [
                            'string',
                        ]
                    },
                ]
            },
            'Id': 'string',
            'Time': datetime(2015, 1, 1),
            'EventSource': 'string',
            'Name': 'string',
            'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
            'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
            'Resources': [
                {
                    'Type': 'string',
                    'Name': 'string',
                    'Arn': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Events (list) –
  
  A list of the requested events.
  - (dict) –
    
    An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
    - ResourceCollection (dict) –
      
      A collection of Amazon Web Services resources supported by DevOps Guru. 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) –
        
        An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.
        
        StackNames (list) –
        
        An array of CloudFormation stack names.
        
        (string) –
      - Tags (list) –
        
        The Amazon Web Services tags that are used by 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.
        
        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.
        
        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) –
    - Id (string) –
      
      The ID of the event.
    - Time (datetime) –
      
      A Timestamp that specifies the time the event occurred.
    - EventSource (string) –
      
      The Amazon Web Services source that emitted the event.
    - Name (string) –
      
      The name of the event.
    - DataSource (string) –
      
      The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event.
    - EventClass (string) –
      
      The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.
    - Resources (list) –
      
      An EventResource object that contains information about the resource that emitted the event.
      - (dict) –
        
        The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
        
        Type (string) –
        
        The type of resource that emitted an event.
        
        Name (string) –
        
        The name of the resource that emitted an event.
        
        Arn (string) –
        
        The Amazon Resource Name (ARN) of the resource that emitted an event.
- 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

list_events#

Request Syntax

Warning

Warning

Warning

Response Syntax

Response Structure

Warning

Warning

Warning

Exceptions