:doc:`Health <../../health>` / Client / describe_event_details

**********************
describe_event_details
**********************



.. py:method:: Health.Client.describe_event_details(**kwargs)

  

  Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by `DescribeEvents <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html>`__), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the `DescribeAffectedEntities <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html>`__ operation.

   

  If a specified event can't be retrieved, an error message is returned for that event.

   

  .. note::

    

    This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see `Resource- and action-based conditions <https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions>`__ in the *Health User Guide*.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetails>`_  


  **Request Syntax**
  ::

    response = client.describe_event_details(
        eventArns=[
            'string',
        ],
        locale='string'
    )
    
  :type eventArns: list
  :param eventArns: **[REQUIRED]** 

    A list of event ARNs (unique identifiers). For example: ``"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"``

    

  
    - *(string) --* 

    

  :type locale: string
  :param locale: 

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    

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

    
    ::

      {
          'successfulSet': [
              {
                  'event': {
                      'arn': 'string',
                      'service': 'string',
                      'eventTypeCode': 'string',
                      'eventTypeCategory': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
                      'region': 'string',
                      'availabilityZone': 'string',
                      'startTime': datetime(2015, 1, 1),
                      'endTime': datetime(2015, 1, 1),
                      'lastUpdatedTime': datetime(2015, 1, 1),
                      'statusCode': 'open'|'closed'|'upcoming',
                      'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
                      'actionability': 'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
                      'personas': [
                          'OPERATIONS'|'SECURITY'|'BILLING',
                      ]
                  },
                  'eventDescription': {
                      'latestDescription': 'string'
                  },
                  'eventMetadata': {
                      'string': 'string'
                  }
              },
          ],
          'failedSet': [
              {
                  'eventArn': 'string',
                  'errorName': 'string',
                  'errorMessage': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **successfulSet** *(list) --* 

        Information about the events that could be retrieved.

        
        

        - *(dict) --* 

          Detailed information about an event. A combination of an `Event <https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html>`__ object, an `EventDescription <https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html>`__ object, and additional metadata about the event. Returned by the `DescribeEventDetails <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html>`__ operation.

          
          

          - **event** *(dict) --* 

            Summary information about the event.

            
            

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

              The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID`` format.

               

              For example, an event ARN might look like the following:

               

              ``arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456``

              
            

            - **service** *(string) --* 

              The Amazon Web Services service that is affected by the event. For example, ``EC2``, ``RDS``.

              
            

            - **eventTypeCode** *(string) --* 

              The unique identifier for the event type. The format is ``AWS_SERVICE_DESCRIPTION ``; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT``.

              
            

            - **eventTypeCategory** *(string) --* 

              A list of event type category codes. Possible values are ``issue``, ``accountNotification``, or ``scheduledChange``. Currently, the ``investigation`` value isn't supported at this time.

              
            

            - **region** *(string) --* 

              The Amazon Web Services Region name of the event.

              
            

            - **availabilityZone** *(string) --* 

              The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

              
            

            - **startTime** *(datetime) --* 

              The date and time that the event began.

              
            

            - **endTime** *(datetime) --* 

              The date and time that the event ended.

              
            

            - **lastUpdatedTime** *(datetime) --* 

              The most recent date and time that the event was updated.

              
            

            - **statusCode** *(string) --* 

              The most recent status of the event. Possible values are ``open``, ``closed``, and ``upcoming``.

              
            

            - **eventScopeCode** *(string) --* 

              This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

               

              
              * If the ``eventScopeCode`` value is ``PUBLIC``, then the ``affectedAccounts`` value is always empty.
               
              * If the ``eventScopeCode`` value is ``ACCOUNT_SPECIFIC``, then the ``affectedAccounts`` value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.
               
              * If the ``eventScopeCode`` value is ``NONE``, then the ``eventArn`` that you specified in the request is invalid or doesn't exist.
              

              
            

            - **actionability** *(string) --* 

              The actionability classification of the event. Possible values are ``ACTION_REQUIRED``, ``ACTION_MAY_BE_REQUIRED`` and ``INFORMATIONAL``. Events with ``ACTION_REQUIRED`` actionability require customer action to resolve or mitigate the event. Events with ``ACTION_MAY_BE_REQUIRED`` actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with ``INFORMATIONAL`` actionability are provided for awareness and do not require immediate action.

              
            

            - **personas** *(list) --* 

              A list of persona classifications that indicate the target audience for the event. Possible values are ``OPERATIONS``, ``SECURITY``, and ``BILLING``. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

              
              

              - *(string) --* 
          
        
          

          - **eventDescription** *(dict) --* 

            The most recent description of the event.

            
            

            - **latestDescription** *(string) --* 

              The most recent description of the event.

              
        
          

          - **eventMetadata** *(dict) --* 

            Additional metadata about the event.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **failedSet** *(list) --* 

        Error messages for any events that could not be retrieved.

        
        

        - *(dict) --* 

          Error information returned when a `DescribeEventDetails <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html>`__ operation can't find a specified event.

          
          

          - **eventArn** *(string) --* 

            The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID`` format.

             

            For example, an event ARN might look like the following:

             

            ``arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456``

            
          

          - **errorName** *(string) --* 

            The name of the error.

            
          

          - **errorMessage** *(string) --* 

            A message that describes the error.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Health.Client.exceptions.UnsupportedLocale`

  