Amazon Pinpoint

2024/04/09 - Amazon Pinpoint - 3 updated api methods

Changes  The OrchestrationSendingRoleArn has been added to the email channel and is used to send emails from campaigns or journeys.

DeleteEmailChannel (updated) Link ¶
Changes (response) 
{'EmailChannelResponse': {'OrchestrationSendingRoleArn': 'string'}}

Disables the email channel for an application and deletes any existing settings for the channel.

See also: AWS API Documentation

Request Syntax

client.delete_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 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.

GetEmailChannel (updated) Link ¶
Changes (response) 
{'EmailChannelResponse': {'OrchestrationSendingRoleArn': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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 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.

UpdateEmailChannel (updated) Link ¶
Changes (request, response)
Request 
{'EmailChannelRequest': {'OrchestrationSendingRoleArn': 'string'}}
Response 
{'EmailChannelResponse': {'OrchestrationSendingRoleArn': 'string'}}

Enables the email channel for an application or updates the status and settings of the email channel for an application.

See also: AWS API Documentation

Request Syntax

client.update_email_channel(
    ApplicationId='string',
    EmailChannelRequest={
        'ConfigurationSet': 'string',
        'Enabled': True|False,
        'FromAddress': 'string',
        'Identity': 'string',
        'RoleArn': 'string',
        'OrchestrationSendingRoleArn': '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.

type EmailChannelRequest

dict

param EmailChannelRequest

[REQUIRED]

Specifies the status and settings of the email channel for an application.

  • ConfigurationSet (string) --

    The Amazon SES configuration set that you want to apply to messages that you send through the channel.

  • Enabled (boolean) --

    Specifies whether to enable the email channel for the application.

  • FromAddress (string) -- [REQUIRED]

    The verified email address that you want to send email from when you send email through the channel.

  • Identity (string) -- [REQUIRED]

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

  • RoleArn (string) --

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits 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.

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 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.