:doc:`Pinpoint <../../pinpoint>` / Client / get_email_channel

*****************
get_email_channel
*****************



.. py:method:: Pinpoint.Client.get_email_channel(**kwargs)

  

  Retrieves information about the status and settings of the email channel for an application.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailChannel>`_  


  **Request Syntax**
  ::

    response = client.get_email_channel(
        ApplicationId='string'
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The unique identifier for the application. This identifier is displayed as the **Project ID** on the Amazon Pinpoint console.

    

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

    
    ::

      {
          'EmailChannelResponse': {
              'ApplicationId': 'string',
              'ConfigurationSet': 'string',
              'CreationDate': 'string',
              'Enabled': True|False,
              'FromAddress': 'string',
              'HasCredential': True|False,
              'Id': 'string',
              'Identity': 'string',
              'IsArchived': True|False,
              'LastModifiedBy': 'string',
              'LastModifiedDate': 'string',
              'MessagesPerSecond': 123,
              'Platform': 'string',
              'RoleArn': 'string',
              'OrchestrationSendingRoleArn': 'string',
              'Version': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request succeeded.

      
      

      - **EmailChannelResponse** *(dict) --* 

        Provides information about the status and settings of the email channel for an application.

        
        

        - **ApplicationId** *(string) --* 

          The unique identifier for the application that the email channel applies to.

          
        

        - **ConfigurationSet** *(string) --* 

          The `Amazon SES configuration set <https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html>`__ that's applied to messages that are sent through the channel.

          
        

        - **CreationDate** *(string) --* 

          The date and time, in ISO 8601 format, when the email channel was enabled.

          
        

        - **Enabled** *(boolean) --* 

          Specifies whether the email channel is enabled for the application.

          
        

        - **FromAddress** *(string) --* 

          The verified email address that email is sent from when you send email through the channel.

          
        

        - **HasCredential** *(boolean) --* 

          (Not used) This property is retained only for backward compatibility.

          
        

        - **Id** *(string) --* 

          (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

          
        

        - **Identity** *(string) --* 

          The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

          
        

        - **IsArchived** *(boolean) --* 

          Specifies whether the email channel is archived.

          
        

        - **LastModifiedBy** *(string) --* 

          The user who last modified the email channel.

          
        

        - **LastModifiedDate** *(string) --* 

          The date and time, in ISO 8601 format, when the email channel was last modified.

          
        

        - **MessagesPerSecond** *(integer) --* 

          The maximum number of emails that can be sent through the channel each second.

          
        

        - **Platform** *(string) --* 

          The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

          
        

        - **RoleArn** *(string) --* 

          The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

          
        

        - **OrchestrationSendingRoleArn** *(string) --* 

          The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

          
        

        - **Version** *(integer) --* 

          The current version of the email channel.

          
    
  
  **Exceptions**
  
  *   :py:class:`Pinpoint.Client.exceptions.BadRequestException`

  
  *   :py:class:`Pinpoint.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Pinpoint.Client.exceptions.PayloadTooLargeException`

  
  *   :py:class:`Pinpoint.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Pinpoint.Client.exceptions.NotFoundException`

  
  *   :py:class:`Pinpoint.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`Pinpoint.Client.exceptions.TooManyRequestsException`

  