PinpointSMSVoiceV2 / Client / update_notify_configuration

update_notify_configuration

PinpointSMSVoiceV2.Client.update_notify_configuration(**kwargs)

Updates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection settings.

See also: AWS API Documentation

Request Syntax

response = client.update_notify_configuration(
    NotifyConfigurationId='string',
    DefaultTemplateId='string',
    PoolId='string',
    EnabledCountries=[
        'string',
    ],
    EnabledChannels=[
        'SMS'|'VOICE'|'MMS'|'RCS',
    ],
    DeletionProtectionEnabled=True|False
)
Parameters:

  • NotifyConfigurationId (string) –

    [REQUIRED]

    The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.

  • DefaultTemplateId (string) – The template ID to set as the default, or the special value UNSET_DEFAULT_TEMPLATE to clear the current default template.

  • PoolId (string) – The pool ID or ARN to associate, or the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool.

  • EnabledCountries (list) –

    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

    • (string) –

  • EnabledChannels (list) –

    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

    • (string) –

  • DeletionProtectionEnabled (boolean) – When set to true the notify configuration can’t be deleted.

Return type:

dict

Returns:

Response Syntax

{
    'NotifyConfigurationArn': 'string',
    'NotifyConfigurationId': 'string',
    'DisplayName': 'string',
    'UseCase': 'CODE_VERIFICATION',
    'DefaultTemplateId': 'string',
    'PoolId': 'string',
    'EnabledCountries': [
        'string',
    ],
    'EnabledChannels': [
        'SMS'|'VOICE'|'MMS'|'RCS',
    ],
    'Tier': 'BASIC'|'ADVANCED',
    'TierUpgradeStatus': 'BASIC'|'PENDING_UPGRADE'|'ADVANCED'|'REJECTED',
    'Status': 'PENDING'|'ACTIVE'|'REJECTED'|'REQUIRES_VERIFICATION',
    'RejectionReason': 'string',
    'DeletionProtectionEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • NotifyConfigurationArn (string) –

      The Amazon Resource Name (ARN) for the notify configuration.

    • NotifyConfigurationId (string) –

      The unique identifier for the notify configuration.

    • DisplayName (string) –

      The display name associated with the notify configuration.

    • UseCase (string) –

      The use case for the notify configuration.

    • DefaultTemplateId (string) –

      The default template identifier associated with the notify configuration.

    • PoolId (string) –

      The identifier of the pool associated with the notify configuration.

    • EnabledCountries (list) –

      An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

      • (string) –

    • EnabledChannels (list) –

      An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.

      • (string) –

    • Tier (string) –

      The tier of the notify configuration.

    • TierUpgradeStatus (string) –

      The tier upgrade status of the notify configuration.

    • Status (string) –

      The current status of the notify configuration.

    • RejectionReason (string) –

      The reason the notify configuration was rejected, if applicable.

    • DeletionProtectionEnabled (boolean) –

      When set to true deletion protection is enabled. By default this is set to false.

    • CreatedTimestamp (datetime) –

      The time when the notify configuration was created, in UNIX epoch time format.

Exceptions