pinpointsmsvoicev2

package module
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 41 Imported by: 0

Documentation

Overview

Package pinpointsmsvoicev2 provides the API client, operations, and parameter types for Amazon Pinpoint SMS Voice V2.

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint SMS, it's also helpful to review the Amazon Pinpoint SMS User Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpointsand Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regionsin the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

Index

Constants

View Source 
const ServiceAPIVersion = "2022-03-31"
View Source 
const ServiceID = "Pinpoint SMS Voice V2"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateOriginationIdentityInput 

type AssociateOriginationIdentityInput struct {

	// The new two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region of the origination identity.
	//
	// This member is required.
	IsoCountryCode *string

	// The origination identity to use, such as PhoneNumberId, PhoneNumberArn,
	// SenderId, or SenderIdArn. You can use DescribePhoneNumbersto find the values for PhoneNumberId and
	// PhoneNumberArn, while DescribeSenderIdscan be used to get the values for SenderId and
	// SenderIdArn.
	//
	// This member is required.
	OriginationIdentity *string

	// The pool to update with the new Identity. This value can be either the PoolId
	// or PoolArn, and you can find these values using DescribePools.
	//
	// This member is required.
	PoolId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type AssociateOriginationIdentityOutput 

type AssociateOriginationIdentityOutput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string

	// The PhoneNumberId or SenderId of the origination identity.
	OriginationIdentity *string

	// The PhoneNumberArn or SenderIdArn of the origination identity.
	OriginationIdentityArn *string

	// The Amazon Resource Name (ARN) of the pool that is now associated with the
	// origination identity.
	PoolArn *string

	// The PoolId of the pool that is now associated with the origination identity.
	PoolId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateProtectConfigurationInput 

type AssociateProtectConfigurationInput struct {

	// The name of the ConfigurationSet.
	//
	// This member is required.
	ConfigurationSetName *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string
	// contains filtered or unexported fields
}

type AssociateProtectConfigurationOutput 

type AssociateProtectConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	//
	// This member is required.
	ConfigurationSetArn *string

	// The name of the ConfigurationSet.
	//
	// This member is required.
	ConfigurationSetName *string

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Pinpoint SMS Voice V2.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateOriginationIdentity 

func (c *Client) AssociateOriginationIdentity(ctx context.Context, params *AssociateOriginationIdentityInput, optFns ...func(*Options)) (*AssociateOriginationIdentityOutput, error)

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an error is returned.

func (*Client) AssociateProtectConfiguration 

func (c *Client) AssociateProtectConfiguration(ctx context.Context, params *AssociateProtectConfigurationInput, optFns ...func(*Options)) (*AssociateProtectConfigurationOutput, error)

Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.

func (*Client) CreateConfigurationSet 

func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfigurationSetInput, optFns ...func(*Options)) (*CreateConfigurationSetOutput, error)

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

func (*Client) CreateEventDestination 

func (c *Client) CreateEventDestination(ctx context.Context, params *CreateEventDestinationInput, optFns ...func(*Options)) (*CreateEventDestinationOutput, error)

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

func (*Client) CreateOptOutList 

func (c *Client) CreateOptOutList(ctx context.Context, params *CreateOptOutListInput, optFns ...func(*Options)) (*CreateOptOutListOutput, error)

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt outin the Amazon Pinpoint User Guide.

func (*Client) CreatePool 

func (c *Client) CreatePool(ctx context.Context, params *CreatePoolInput, optFns ...func(*Options)) (*CreatePoolOutput, error)

Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

func (*Client) CreateProtectConfiguration 

func (c *Client) CreateProtectConfiguration(ctx context.Context, params *CreateProtectConfigurationInput, optFns ...func(*Options)) (*CreateProtectConfigurationOutput, error)

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW . Update the country rule sets using UpdateProtectConfigurationCountryRuleSet . A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

func (*Client) CreateRegistration 

func (c *Client) CreateRegistration(ctx context.Context, params *CreateRegistrationInput, optFns ...func(*Options)) (*CreateRegistrationOutput, error)

Creates a new registration based on the RegistrationType field.

func (*Client) CreateRegistrationAssociation 

func (c *Client) CreateRegistrationAssociation(ctx context.Context, params *CreateRegistrationAssociationInput, optFns ...func(*Options)) (*CreateRegistrationAssociationOutput, error)

Associate the registration with an origination identity such as a phone number or sender ID.

func (*Client) CreateRegistrationAttachment 

func (c *Client) CreateRegistrationAttachment(ctx context.Context, params *CreateRegistrationAttachmentInput, optFns ...func(*Options)) (*CreateRegistrationAttachmentOutput, error)

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

func (*Client) CreateRegistrationVersion 

func (c *Client) CreateRegistrationVersion(ctx context.Context, params *CreateRegistrationVersionInput, optFns ...func(*Options)) (*CreateRegistrationVersionOutput, error)

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

func (*Client) CreateVerifiedDestinationNumber 

func (c *Client) CreateVerifiedDestinationNumber(ctx context.Context, params *CreateVerifiedDestinationNumberInput, optFns ...func(*Options)) (*CreateVerifiedDestinationNumberOutput, error)

You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.

func (*Client) DeleteAccountDefaultProtectConfiguration 

func (c *Client) DeleteAccountDefaultProtectConfiguration(ctx context.Context, params *DeleteAccountDefaultProtectConfigurationInput, optFns ...func(*Options)) (*DeleteAccountDefaultProtectConfigurationOutput, error)

Removes the current account default protect configuration.

func (*Client) DeleteConfigurationSet 

func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error)

Deletes an existing configuration set.

A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

func (*Client) DeleteDefaultMessageType 

func (c *Client) DeleteDefaultMessageType(ctx context.Context, params *DeleteDefaultMessageTypeInput, optFns ...func(*Options)) (*DeleteDefaultMessageTypeOutput, error)

Deletes an existing default message type on a configuration set.

A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

func (*Client) DeleteDefaultSenderId 

func (c *Client) DeleteDefaultSenderId(ctx context.Context, params *DeleteDefaultSenderIdInput, optFns ...func(*Options)) (*DeleteDefaultSenderIdOutput, error)

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

func (*Client) DeleteEventDestination 

func (c *Client) DeleteEventDestination(ctx context.Context, params *DeleteEventDestinationInput, optFns ...func(*Options)) (*DeleteEventDestinationOutput, error)

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

func (*Client) DeleteKeyword 

func (c *Client) DeleteKeyword(ctx context.Context, params *DeleteKeywordInput, optFns ...func(*Options)) (*DeleteKeywordOutput, error)

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords "HELP" and "STOP" can't be deleted or modified.

func (*Client) DeleteMediaMessageSpendLimitOverride 

func (c *Client) DeleteMediaMessageSpendLimitOverride(ctx context.Context, params *DeleteMediaMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*DeleteMediaMessageSpendLimitOverrideOutput, error)

Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit , which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Servicein the Server Migration Service User Guide.

func (*Client) DeleteOptOutList 

func (c *Client) DeleteOptOutList(ctx context.Context, params *DeleteOptOutListInput, optFns ...func(*Options)) (*DeleteOptOutListOutput, error)

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.

func (*Client) DeleteOptedOutNumber 

func (c *Client) DeleteOptedOutNumber(ctx context.Context, params *DeleteOptedOutNumberInput, optFns ...func(*Options)) (*DeleteOptedOutNumberOutput, error)

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.

func (*Client) DeletePool 

func (c *Client) DeletePool(ctx context.Context, params *DeletePoolInput, optFns ...func(*Options)) (*DeletePoolOutput, error)

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn't active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

func (*Client) DeleteProtectConfiguration 

func (c *Client) DeleteProtectConfiguration(ctx context.Context, params *DeleteProtectConfigurationInput, optFns ...func(*Options)) (*DeleteProtectConfigurationOutput, error)

Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.

func (*Client) DeleteRegistration 

func (c *Client) DeleteRegistration(ctx context.Context, params *DeleteRegistrationInput, optFns ...func(*Options)) (*DeleteRegistrationOutput, error)

Permanently delete an existing registration from your account.

func (*Client) DeleteRegistrationAttachment 

func (c *Client) DeleteRegistrationAttachment(ctx context.Context, params *DeleteRegistrationAttachmentInput, optFns ...func(*Options)) (*DeleteRegistrationAttachmentOutput, error)

Permanently delete the specified registration attachment.

func (*Client) DeleteRegistrationFieldValue 

func (c *Client) DeleteRegistrationFieldValue(ctx context.Context, params *DeleteRegistrationFieldValueInput, optFns ...func(*Options)) (*DeleteRegistrationFieldValueOutput, error)

Delete the value in a registration form field.

func (*Client) DeleteTextMessageSpendLimitOverride 

func (c *Client) DeleteTextMessageSpendLimitOverride(ctx context.Context, params *DeleteTextMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*DeleteTextMessageSpendLimitOverrideOutput, error)

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit , which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotasin the Amazon Pinpoint Developer Guide.

func (*Client) DeleteVerifiedDestinationNumber 

func (c *Client) DeleteVerifiedDestinationNumber(ctx context.Context, params *DeleteVerifiedDestinationNumberInput, optFns ...func(*Options)) (*DeleteVerifiedDestinationNumberOutput, error)

Delete a verified destination phone number.

func (*Client) DeleteVoiceMessageSpendLimitOverride 

func (c *Client) DeleteVoiceMessageSpendLimitOverride(ctx context.Context, params *DeleteVoiceMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*DeleteVoiceMessageSpendLimitOverrideOutput, error)

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit , which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotasin the Amazon Pinpoint Developer Guide.

func (*Client) DescribeAccountAttributes 

func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error)

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

func (*Client) DescribeAccountLimits 

func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error)

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotasin the Amazon Pinpoint Developer Guide.

func (*Client) DescribeConfigurationSets 

func (c *Client) DescribeConfigurationSets(ctx context.Context, params *DescribeConfigurationSetsInput, optFns ...func(*Options)) (*DescribeConfigurationSetsOutput, error)

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn't valid, an error is returned.

func (*Client) DescribeKeywords 

func (c *Client) DescribeKeywords(ctx context.Context, params *DescribeKeywordsInput, optFns ...func(*Options)) (*DescribeKeywordsOutput, error)

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

func (*Client) DescribeOptOutLists 

func (c *Client) DescribeOptOutLists(ctx context.Context, params *DescribeOptOutListsInput, optFns ...func(*Options)) (*DescribeOptOutListsOutput, error)

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an error is returned.

func (*Client) DescribeOptedOutNumbers 

func (c *Client) DescribeOptedOutNumbers(ctx context.Context, params *DescribeOptedOutNumbersInput, optFns ...func(*Options)) (*DescribeOptedOutNumbersOutput, error)

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an error is returned.

func (*Client) DescribePhoneNumbers 

func (c *Client) DescribePhoneNumbers(ctx context.Context, params *DescribePhoneNumbersInput, optFns ...func(*Options)) (*DescribePhoneNumbersOutput, error)

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

func (*Client) DescribePools 

func (c *Client) DescribePools(ctx context.Context, params *DescribePoolsInput, optFns ...func(*Options)) (*DescribePoolsOutput, error)

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn't valid, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

func (*Client) DescribeProtectConfigurations 

func (c *Client) DescribeProtectConfigurations(ctx context.Context, params *DescribeProtectConfigurationsInput, optFns ...func(*Options)) (*DescribeProtectConfigurationsOutput, error)

Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

func (*Client) DescribeRegistrationAttachments 

func (c *Client) DescribeRegistrationAttachments(ctx context.Context, params *DescribeRegistrationAttachmentsInput, optFns ...func(*Options)) (*DescribeRegistrationAttachmentsOutput, error)

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

func (*Client) DescribeRegistrationFieldDefinitions 

func (c *Client) DescribeRegistrationFieldDefinitions(ctx context.Context, params *DescribeRegistrationFieldDefinitionsInput, optFns ...func(*Options)) (*DescribeRegistrationFieldDefinitionsOutput, error)

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

func (*Client) DescribeRegistrationFieldValues 

func (c *Client) DescribeRegistrationFieldValues(ctx context.Context, params *DescribeRegistrationFieldValuesInput, optFns ...func(*Options)) (*DescribeRegistrationFieldValuesOutput, error)

Retrieves the specified registration field values.

func (*Client) DescribeRegistrationSectionDefinitions 

func (c *Client) DescribeRegistrationSectionDefinitions(ctx context.Context, params *DescribeRegistrationSectionDefinitionsInput, optFns ...func(*Options)) (*DescribeRegistrationSectionDefinitionsOutput, error)

Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.

func (*Client) DescribeRegistrationTypeDefinitions 

func (c *Client) DescribeRegistrationTypeDefinitions(ctx context.Context, params *DescribeRegistrationTypeDefinitionsInput, optFns ...func(*Options)) (*DescribeRegistrationTypeDefinitionsOutput, error)

Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.

func (*Client) DescribeRegistrationVersions 

func (c *Client) DescribeRegistrationVersions(ctx context.Context, params *DescribeRegistrationVersionsInput, optFns ...func(*Options)) (*DescribeRegistrationVersionsOutput, error)

Retrieves the specified registration version.

func (*Client) DescribeRegistrations 

func (c *Client) DescribeRegistrations(ctx context.Context, params *DescribeRegistrationsInput, optFns ...func(*Options)) (*DescribeRegistrationsOutput, error)

Retrieves the specified registrations.

func (*Client) DescribeSenderIds 

func (c *Client) DescribeSenderIds(ctx context.Context, params *DescribeSenderIdsInput, optFns ...func(*Options)) (*DescribeSenderIdsOutput, error)

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn't valid, an error is returned.

func (*Client) DescribeSpendLimits 

func (c *Client) DescribeSpendLimits(ctx context.Context, params *DescribeSpendLimitsInput, optFns ...func(*Options)) (*DescribeSpendLimitsOutput, error)

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpointin the Amazon Pinpoint User Guide.

func (*Client) DescribeVerifiedDestinationNumbers 

func (c *Client) DescribeVerifiedDestinationNumbers(ctx context.Context, params *DescribeVerifiedDestinationNumbersInput, optFns ...func(*Options)) (*DescribeVerifiedDestinationNumbersOutput, error)

Retrieves the specified verified destiona numbers.

func (*Client) DisassociateOriginationIdentity 

func (c *Client) DisassociateOriginationIdentity(ctx context.Context, params *DisassociateOriginationIdentityInput, optFns ...func(*Options)) (*DisassociateOriginationIdentityOutput, error)

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an error is returned.

func (*Client) DisassociateProtectConfiguration 

func (c *Client) DisassociateProtectConfiguration(ctx context.Context, params *DisassociateProtectConfigurationInput, optFns ...func(*Options)) (*DisassociateProtectConfigurationOutput, error)

Disassociate a protect configuration from a configuration set.

func (*Client) DiscardRegistrationVersion 

func (c *Client) DiscardRegistrationVersion(ctx context.Context, params *DiscardRegistrationVersionInput, optFns ...func(*Options)) (*DiscardRegistrationVersionOutput, error)

Discard the current version of the registration.

func (*Client) GetProtectConfigurationCountryRuleSet 

func (c *Client) GetProtectConfigurationCountryRuleSet(ctx context.Context, params *GetProtectConfigurationCountryRuleSetInput, optFns ...func(*Options)) (*GetProtectConfigurationCountryRuleSetOutput, error)

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

func (*Client) ListPoolOriginationIdentities 

func (c *Client) ListPoolOriginationIdentities(ctx context.Context, params *ListPoolOriginationIdentitiesInput, optFns ...func(*Options)) (*ListPoolOriginationIdentitiesOutput, error)

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

func (*Client) ListRegistrationAssociations 

func (c *Client) ListRegistrationAssociations(ctx context.Context, params *ListRegistrationAssociationsInput, optFns ...func(*Options)) (*ListRegistrationAssociationsOutput, error)

Retreive all of the origination identies that are associated with a registration.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List all tags associated with a resource.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutKeyword 

func (c *Client) PutKeyword(ctx context.Context, params *PutKeywordInput, optFns ...func(*Options)) (*PutKeywordOutput, error)

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

func (*Client) PutOptedOutNumber 

func (c *Client) PutOptedOutNumber(ctx context.Context, params *PutOptedOutNumberInput, optFns ...func(*Options)) (*PutOptedOutNumberOutput, error)

Creates an opted out destination phone number in the opt-out list.

If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.

func (*Client) PutRegistrationFieldValue 

func (c *Client) PutRegistrationFieldValue(ctx context.Context, params *PutRegistrationFieldValueInput, optFns ...func(*Options)) (*PutRegistrationFieldValueOutput, error)

Creates or updates a field value for a registration.

func (*Client) ReleasePhoneNumber 

func (c *Client) ReleasePhoneNumber(ctx context.Context, params *ReleasePhoneNumberInput, optFns ...func(*Options)) (*ReleasePhoneNumberOutput, error)

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.

func (*Client) ReleaseSenderId 

func (c *Client) ReleaseSenderId(ctx context.Context, params *ReleaseSenderIdInput, optFns ...func(*Options)) (*ReleaseSenderIdOutput, error)

Releases an existing sender ID in your account.

func (*Client) RequestPhoneNumber 

func (c *Client) RequestPhoneNumber(ctx context.Context, params *RequestPhoneNumberInput, optFns ...func(*Options)) (*RequestPhoneNumberOutput, error)

Request an origination phone number for use in your account. For more information on phone number request see Requesting a numberin the Amazon Pinpoint User Guide.

func (*Client) RequestSenderId 

func (c *Client) RequestSenderId(ctx context.Context, params *RequestSenderIdInput, optFns ...func(*Options)) (*RequestSenderIdOutput, error)

Request a new sender ID that doesn't require registration.

func (*Client) SendDestinationNumberVerificationCode 

func (c *Client) SendDestinationNumberVerificationCode(ctx context.Context, params *SendDestinationNumberVerificationCodeInput, optFns ...func(*Options)) (*SendDestinationNumberVerificationCodeOutput, error)

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumberto opt-in the verified destination phone number to receive messages.

func (*Client) SendMediaMessage 

func (c *Client) SendMediaMessage(ctx context.Context, params *SendMediaMessageInput, optFns ...func(*Options)) (*SendMediaMessageOutput, error)

Creates a new multimedia message (MMS) and sends it to a recipient's phone number.

func (*Client) SendTextMessage 

func (c *Client) SendTextMessage(ctx context.Context, params *SendTextMessageInput, optFns ...func(*Options)) (*SendTextMessageOutput, error)

Creates a new text message and sends it to a recipient's phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limitsin the Amazon Pinpoint User Guide.

func (*Client) SendVoiceMessage 

func (c *Client) SendVoiceMessage(ctx context.Context, params *SendVoiceMessageInput, optFns ...func(*Options)) (*SendVoiceMessageOutput, error)

Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Pollyto convert a text script into a voice message.

func (*Client) SetAccountDefaultProtectConfiguration 

func (c *Client) SetAccountDefaultProtectConfiguration(ctx context.Context, params *SetAccountDefaultProtectConfigurationInput, optFns ...func(*Options)) (*SetAccountDefaultProtectConfigurationOutput, error)

Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.

func (*Client) SetDefaultMessageType 

func (c *Client) SetDefaultMessageType(ctx context.Context, params *SetDefaultMessageTypeInput, optFns ...func(*Options)) (*SetDefaultMessageTypeOutput, error)

Sets the default message type on a configuration set.

Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

func (*Client) SetDefaultSenderId 

func (c *Client) SetDefaultSenderId(ctx context.Context, params *SetDefaultSenderIdInput, optFns ...func(*Options)) (*SetDefaultSenderIdOutput, error)

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

func (*Client) SetMediaMessageSpendLimitOverride 

func (c *Client) SetMediaMessageSpendLimitOverride(ctx context.Context, params *SetMediaMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*SetMediaMessageSpendLimitOverrideOutput, error)

Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit , which is set by Amazon Web Services.

func (*Client) SetTextMessageSpendLimitOverride 

func (c *Client) SetTextMessageSpendLimitOverride(ctx context.Context, params *SetTextMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*SetTextMessageSpendLimitOverrideOutput, error)

Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit , which is set by Amazon Web Services.

func (*Client) SetVoiceMessageSpendLimitOverride 

func (c *Client) SetVoiceMessageSpendLimitOverride(ctx context.Context, params *SetVoiceMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*SetVoiceMessageSpendLimitOverrideOutput, error)

Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit , which is set by Amazon Web Services.

func (*Client) SubmitRegistrationVersion 

func (c *Client) SubmitRegistrationVersion(ctx context.Context, params *SubmitRegistrationVersionInput, optFns ...func(*Options)) (*SubmitRegistrationVersionOutput, error)

Submit the specified registration for review and approval.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resourcesin the Amazon Pinpoint Developer Guide.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resourcesin the Amazon Pinpoint Developer Guide.

func (*Client) UpdateEventDestination 

func (c *Client) UpdateEventDestination(ctx context.Context, params *UpdateEventDestinationInput, optFns ...func(*Options)) (*UpdateEventDestinationOutput, error)

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

func (*Client) UpdatePhoneNumber 

func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error)

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an error is returned.

func (*Client) UpdatePool 

func (c *Client) UpdatePool(ctx context.Context, params *UpdatePoolInput, optFns ...func(*Options)) (*UpdatePoolOutput, error)

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn , enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

func (*Client) UpdateProtectConfiguration 

func (c *Client) UpdateProtectConfiguration(ctx context.Context, params *UpdateProtectConfigurationInput, optFns ...func(*Options)) (*UpdateProtectConfigurationOutput, error)

Update the setting for an existing protect configuration.

func (*Client) UpdateProtectConfigurationCountryRuleSet 

func (c *Client) UpdateProtectConfigurationCountryRuleSet(ctx context.Context, params *UpdateProtectConfigurationCountryRuleSetInput, optFns ...func(*Options)) (*UpdateProtectConfigurationCountryRuleSetOutput, error)

Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.

func (*Client) UpdateSenderId 

func (c *Client) UpdateSenderId(ctx context.Context, params *UpdateSenderIdInput, optFns ...func(*Options)) (*UpdateSenderIdOutput, error)

Updates the configuration of an existing sender ID.

func (*Client) VerifyDestinationNumber 

func (c *Client) VerifyDestinationNumber(ctx context.Context, params *VerifyDestinationNumberInput, optFns ...func(*Options)) (*VerifyDestinationNumberOutput, error)

Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

type CreateConfigurationSetInput 

type CreateConfigurationSetInput struct {

	// The name to use for the new configuration set.
	//
	// This member is required.
	ConfigurationSetName *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// An array of key and value pair tags that's associated with the new
	// configuration set.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateConfigurationSetOutput 

type CreateConfigurationSetOutput struct {

	// The Amazon Resource Name (ARN) of the newly created configuration set.
	ConfigurationSetArn *string

	// The name of the new configuration set.
	ConfigurationSetName *string

	// The time when the configuration set was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// An array of key and value pair tags that's associated with the configuration
	// set.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateEventDestinationInput 

type CreateEventDestinationInput struct {

	// Either the name of the configuration set or the configuration set ARN to apply
	// event logging to. The ConfigurateSetName and ConfigurationSetArn can be found
	// using the DescribeConfigurationSetsaction.
	//
	// This member is required.
	ConfigurationSetName *string

	// The name that identifies the event destination.
	//
	// This member is required.
	EventDestinationName *string

	// An array of event types that determine which events to log. If "ALL" is used,
	// then Amazon Pinpoint logs every event type.
	//
	// The TEXT_SENT event type is not supported.
	//
	// This member is required.
	MatchingEventTypes []types.EventType

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// An object that contains information about an event destination for logging to
	// Amazon CloudWatch Logs.
	CloudWatchLogsDestination *types.CloudWatchLogsDestination

	// An object that contains information about an event destination for logging to
	// Amazon Kinesis Data Firehose.
	KinesisFirehoseDestination *types.KinesisFirehoseDestination

	// An object that contains information about an event destination for logging to
	// Amazon SNS.
	SnsDestination *types.SnsDestination
	// contains filtered or unexported fields
}

type CreateEventDestinationOutput 

type CreateEventDestinationOutput struct {

	// The ARN of the configuration set.
	ConfigurationSetArn *string

	// The name of the configuration set.
	ConfigurationSetName *string

	// The details of the destination where events are logged.
	EventDestination *types.EventDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateOptOutListInput 

type CreateOptOutListInput struct {

	// The name of the new OptOutList.
	//
	// This member is required.
	OptOutListName *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// An array of tags (key and value pairs) to associate with the new OptOutList.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateOptOutListOutput 

type CreateOptOutListOutput struct {

	// The time when the pool was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// The Amazon Resource Name (ARN) for the OptOutList.
	OptOutListArn *string

	// The name of the new OptOutList.
	OptOutListName *string

	// An array of tags (key and value pairs) associated with the new OptOutList.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePoolInput 

type CreatePoolInput struct {

	// The new two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region of the new pool.
	//
	// This member is required.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	//
	// This member is required.
	MessageType types.MessageType

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbersto find the values for PhoneNumberId and
	// PhoneNumberArn while DescribeSenderIdscan be used to get the values for SenderId and SenderIdArn.
	//
	// This member is required.
	OriginationIdentity *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// By default this is set to false. When set to true the pool can't be deleted.
	// You can change this value using the UpdatePoolaction.
	DeletionProtectionEnabled *bool

	// An array of tags (key and value pairs) associated with the pool.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreatePoolOutput 

type CreatePoolOutput struct {

	// The time when the pool was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

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

	// The type of message for the pool to use.
	MessageType types.MessageType

	// The name of the OptOutList associated with the pool.
	OptOutListName *string

	// The Amazon Resource Name (ARN) for the pool.
	PoolArn *string

	// The unique identifier for the pool.
	PoolId *string

	// By default this is set to false. When an end recipient sends a message that
	// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
	// automatically replies with a customizable message and adds the end recipient to
	// the OptOutList. When set to true you're responsible for responding to HELP and
	// STOP requests. You're also responsible for tracking and honoring opt-out
	// requests.
	SelfManagedOptOutsEnabled bool

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled bool

	// The current status of the pool.
	//
	//   - CREATING: The pool is currently being created and isn't yet available for
	//   use.
	//
	//   - ACTIVE: The pool is active and available for use.
	//
	//   - DELETING: The pool is being deleted.
	Status types.PoolStatus

	// An array of tags (key and value pairs) associated with the pool.
	Tags []types.Tag

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProtectConfigurationInput 

type CreateProtectConfigurationInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// When set to true deletion protection is enabled. By default this is set to
	// false.
	DeletionProtectionEnabled *bool

	// An array of key and value pair tags that are associated with the resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateProtectConfigurationOutput 

type CreateProtectConfigurationOutput struct {

	// This is true if the protect configuration is set as your account default
	// protect configuration.
	//
	// This member is required.
	AccountDefault bool

	// The time when the protect configuration was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// When set to true deletion protection is enabled. By default this is set to
	// false.
	//
	// This member is required.
	DeletionProtectionEnabled bool

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// An array of key and value pair tags that are associated with the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRegistrationAssociationInput 

type CreateRegistrationAssociationInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The unique identifier for the origination identity. For example this could be a
	// PhoneNumberId or SenderId.
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type CreateRegistrationAssociationOutput 

type CreateRegistrationAssociationOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// The Amazon Resource Name (ARN) of the origination identity that is associated
	// with the registration.
	//
	// This member is required.
	ResourceArn *string

	// The unique identifier for the origination identity. For example this could be a
	// PhoneNumberId or SenderId.
	//
	// This member is required.
	ResourceId *string

	// The registration type or origination identity type.
	//
	// This member is required.
	ResourceType *string

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	IsoCountryCode *string

	// The phone number associated with the registration in E.164 format.
	PhoneNumber *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRegistrationAttachmentInput 

type CreateRegistrationAttachmentInput struct {

	// The registration file to upload. The maximum file size is 1MiB and valid file
	// extensions are PDF, JPEG and PNG.
	AttachmentBody []byte

	// A URL to the required registration file. For example, you can provide the S3
	// object URL.
	AttachmentUrl *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// An array of tags (key and value pairs) to associate with the registration
	// attachment.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRegistrationAttachmentOutput 

type CreateRegistrationAttachmentOutput struct {

	// The status of the registration attachment.
	//
	//   - UPLOAD_IN_PROGRESS The attachment is being uploaded.
	//
	//   - UPLOAD_COMPLETE The attachment has been uploaded.
	//
	//   - UPLOAD_FAILED The attachment failed to uploaded.
	//
	//   - DELETED The attachment has been deleted..
	//
	// This member is required.
	AttachmentStatus types.AttachmentStatus

	// The time when the registration attachment was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The Amazon Resource Name (ARN) for the registration attachment.
	//
	// This member is required.
	RegistrationAttachmentArn *string

	// The unique identifier for the registration attachment.
	//
	// This member is required.
	RegistrationAttachmentId *string

	// An array of tags (key and value pairs) to associate with the registration
	// attachment.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRegistrationInput 

type CreateRegistrationInput struct {

	// The type of registration form to create. The list of RegistrationTypes can be
	// found using the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// An array of tags (key and value pairs) to associate with the registration.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRegistrationOutput 

type CreateRegistrationOutput struct {

	// The time when the registration was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The current version number of the registration.
	//
	// This member is required.
	CurrentVersionNumber *int64

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The status of the registration.
	//
	//   - CREATED : Your registration is created but not submitted.
	//
	//   - SUBMITTED : Your registration has been submitted and is awaiting review.
	//
	//   - REVIEWING : Your registration has been accepted and is being reviewed.
	//
	//   - PROVISIONING : Your registration has been approved and your origination
	//   identity is being created.
	//
	//   - COMPLETE : Your registration has been approved and and your origination
	//   identity has been created.
	//
	//   - REQUIRES_UPDATES : You must fix your registration and resubmit it.
	//
	//   - CLOSED : The phone number or sender ID has been deleted and you must also
	//   delete the registration for the number.
	//
	//   - DELETED : The registration has been deleted.
	//
	// This member is required.
	RegistrationStatus types.RegistrationStatus

	// The type of registration form to create. The list of RegistrationTypes can be
	// found using the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// Metadata about a given registration which is specific to that registration type.
	AdditionalAttributes map[string]string

	// An array of tags (key and value pairs) to associate with the registration.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRegistrationVersionInput 

type CreateRegistrationVersionInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string
	// contains filtered or unexported fields
}

type CreateRegistrationVersionOutput 

type CreateRegistrationVersionOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The status of the registration.
	//
	//   - DRAFT : The initial status of a registration version after it’s created.
	//
	//   - SUBMITTED : Your registration has been submitted.
	//
	//   - REVIEWING : Your registration has been accepted and is being reviewed.
	//
	//   - APPROVED : Your registration has been approved.
	//
	//   - DISCARDED : You've abandon this version of their registration to start over
	//   with a new version.
	//
	//   - DENIED : You must fix your registration and resubmit it.
	//
	//   - REVOKED : Your previously approved registration has been revoked.
	//
	//   - ARCHIVED : Your previously approved registration version moves into this
	//   status when a more recently submitted version is approved.
	//
	// This member is required.
	RegistrationVersionStatus types.RegistrationVersionStatus

	// A RegistrationVersionStatusHistory object that contains timestamps for the
	// registration.
	//
	// This member is required.
	RegistrationVersionStatusHistory *types.RegistrationVersionStatusHistory

	// The new version number of the registration.
	//
	// This member is required.
	VersionNumber *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVerifiedDestinationNumberInput 

type CreateVerifiedDestinationNumberInput struct {

	// The verified destination phone number, in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// An array of tags (key and value pairs) to associate with the destination number.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateVerifiedDestinationNumberOutput 

type CreateVerifiedDestinationNumberOutput struct {

	// The time when the verified phone number was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The verified destination phone number, in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// The status of the verified destination phone number.
	//
	//   - PENDING : The phone number hasn't been verified yet.
	//
	//   - VERIFIED : The phone number is verified and can receive messages.
	//
	// This member is required.
	Status types.VerificationStatus

	// The Amazon Resource Name (ARN) for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberArn *string

	// The unique identifier for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberId *string

	// An array of tags (key and value pairs) to associate with the destination number.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAccountDefaultProtectConfigurationInput 

type DeleteAccountDefaultProtectConfigurationInput struct {
	// contains filtered or unexported fields
}

type DeleteAccountDefaultProtectConfigurationOutput 

type DeleteAccountDefaultProtectConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the account default protect configuration.
	//
	// This member is required.
	DefaultProtectConfigurationArn *string

	// The unique identifier of the account default protect configuration.
	//
	// This member is required.
	DefaultProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConfigurationSetInput 

type DeleteConfigurationSetInput struct {

	// The name of the configuration set or the configuration set ARN that you want to
	// delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets
	// action.
	//
	// This member is required.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

type DeleteConfigurationSetOutput 

type DeleteConfigurationSetOutput struct {

	// The Amazon Resource Name (ARN) of the deleted configuration set.
	ConfigurationSetArn *string

	// The name of the deleted configuration set.
	ConfigurationSetName *string

	// The time that the deleted configuration set was created in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// The default message type of the configuration set that was deleted.
	DefaultMessageType types.MessageType

	// The default Sender ID of the configuration set that was deleted.
	DefaultSenderId *string

	// An array of any EventDestination objects that were associated with the deleted
	// configuration set.
	EventDestinations []types.EventDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDefaultMessageTypeInput 

type DeleteDefaultMessageTypeInput struct {

	// The name of the configuration set or the configuration set Amazon Resource Name
	// (ARN) to delete the default message type from. The ConfigurationSetName and
	// ConfigurationSetArn can be found using the DescribeConfigurationSetsaction.
	//
	// This member is required.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

type DeleteDefaultMessageTypeOutput 

type DeleteDefaultMessageTypeOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	ConfigurationSetArn *string

	// The name of the configuration set.
	ConfigurationSetName *string

	// The current message type for the configuration set.
	MessageType types.MessageType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDefaultSenderIdInput 

type DeleteDefaultSenderIdInput struct {

	// The name of the configuration set or the configuration set Amazon Resource Name
	// (ARN) to delete the default sender ID from. The ConfigurationSetName and
	// ConfigurationSetArn can be found using the DescribeConfigurationSetsaction.
	//
	// This member is required.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

type DeleteDefaultSenderIdOutput 

type DeleteDefaultSenderIdOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	ConfigurationSetArn *string

	// The name of the configuration set.
	ConfigurationSetName *string

	// The current sender ID for the configuration set.
	SenderId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEventDestinationInput 

type DeleteEventDestinationInput struct {

	// The name of the configuration set or the configuration set's Amazon Resource
	// Name (ARN) to remove the event destination from. The ConfigurateSetName and
	// ConfigurationSetArn can be found using the DescribeConfigurationSetsaction.
	//
	// This member is required.
	ConfigurationSetName *string

	// The name of the event destination to delete.
	//
	// This member is required.
	EventDestinationName *string
	// contains filtered or unexported fields
}

type DeleteEventDestinationOutput 

type DeleteEventDestinationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	ConfigurationSetArn *string

	// The name of the configuration set the event destination was deleted from.
	ConfigurationSetName *string

	// The event destination object that was deleted.
	EventDestination *types.EventDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKeywordInput 

type DeleteKeywordInput struct {

	// The keyword to delete.
	//
	// This member is required.
	Keyword *string

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId
	// or PoolArn. You can use DescribePhoneNumbersto find the values for PhoneNumberId and PhoneNumberArn
	// and DescribePoolsto find the values of PoolId and PoolArn.
	//
	// This member is required.
	OriginationIdentity *string
	// contains filtered or unexported fields
}

type DeleteKeywordOutput 

type DeleteKeywordOutput struct {

	// The keyword that was deleted.
	Keyword *string

	// The action that was associated with the deleted keyword.
	KeywordAction types.KeywordAction

	// The message that was associated with the deleted keyword.
	KeywordMessage *string

	// The PhoneNumberId or PoolId that the keyword was associated with.
	OriginationIdentity *string

	// The PhoneNumberArn or PoolArn that the keyword was associated with.
	OriginationIdentityArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMediaMessageSpendLimitOverrideInput 

type DeleteMediaMessageSpendLimitOverrideInput struct {
	// contains filtered or unexported fields
}

type DeleteMediaMessageSpendLimitOverrideOutput 

type DeleteMediaMessageSpendLimitOverrideOutput struct {

	// The current monthly limit, in US dollars.
	MonthlyLimit *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteOptOutListInput 

type DeleteOptOutListInput struct {

	// The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists
	// to find the values for OptOutListName and OptOutListArn.
	//
	// This member is required.
	OptOutListName *string
	// contains filtered or unexported fields
}

type DeleteOptOutListOutput 

type DeleteOptOutListOutput struct {

	// The time when the OptOutList was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// The Amazon Resource Name (ARN) of the OptOutList that was removed.
	OptOutListArn *string

	// The name of the OptOutList that was removed.
	OptOutListName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteOptedOutNumberInput 

type DeleteOptedOutNumberInput struct {

	// The OptOutListName or OptOutListArn to remove the phone number from.
	//
	// This member is required.
	OptOutListName *string

	// The phone number, in E.164 format, to remove from the OptOutList.
	//
	// This member is required.
	OptedOutNumber *string
	// contains filtered or unexported fields
}

type DeleteOptedOutNumberOutput 

type DeleteOptedOutNumberOutput struct {

	// This is true if it was the end user who requested their phone number be
	// removed.
	EndUserOptedOut bool

	// The OptOutListArn that the phone number was removed from.
	OptOutListArn *string

	// The OptOutListName that the phone number was removed from.
	OptOutListName *string

	// The phone number that was removed from the OptOutList.
	OptedOutNumber *string

	// The time that the number was removed at, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	OptedOutTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePoolInput 

type DeletePoolInput struct {

	// The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values
	// for PoolId and PoolArn .
	//
	// This member is required.
	PoolId *string
	// contains filtered or unexported fields
}

type DeletePoolOutput 

type DeletePoolOutput struct {

	// The time when the pool was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// The message type that was associated with the deleted pool.
	MessageType types.MessageType

	// The name of the OptOutList that was associated with the deleted pool.
	OptOutListName *string

	// The Amazon Resource Name (ARN) of the pool that was deleted.
	PoolArn *string

	// The PoolId of the pool that was deleted.
	PoolId *string

	// By default this is set to false. When an end recipient sends a message that
	// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
	// automatically replies with a customizable message and adds the end recipient to
	// the OptOutList. When set to true you're responsible for responding to HELP and
	// STOP requests. You're also responsible for tracking and honoring opt-out
	// requests.
	SelfManagedOptOutsEnabled bool

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled bool

	// The current status of the pool.
	//
	//   - CREATING: The pool is currently being created and isn't yet available for
	//   use.
	//
	//   - ACTIVE: The pool is active and available for use.
	//
	//   - DELETING: The pool is being deleted.
	Status types.PoolStatus

	// The Amazon Resource Name (ARN) of the TwoWayChannel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProtectConfigurationInput 

type DeleteProtectConfigurationInput struct {

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string
	// contains filtered or unexported fields
}

type DeleteProtectConfigurationOutput 

type DeleteProtectConfigurationOutput struct {

	// This is true if the protect configuration is set as your account default
	// protect configuration.
	//
	// This member is required.
	AccountDefault bool

	// The time when the protect configuration was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The status of deletion protection for the protect configuration. When set to
	// true deletion protection is enabled. By default this is set to false.
	//
	// This member is required.
	DeletionProtectionEnabled bool

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRegistrationAttachmentInput 

type DeleteRegistrationAttachmentInput struct {

	// The unique identifier for the registration attachment.
	//
	// This member is required.
	RegistrationAttachmentId *string
	// contains filtered or unexported fields
}

type DeleteRegistrationAttachmentOutput 

type DeleteRegistrationAttachmentOutput struct {

	// The status of the registration attachment.
	//
	//   - UPLOAD_IN_PROGRESS The attachment is being uploaded.
	//
	//   - UPLOAD_COMPLETE The attachment has been uploaded.
	//
	//   - UPLOAD_FAILED The attachment failed to uploaded.
	//
	//   - DELETED The attachment has been deleted..
	//
	// This member is required.
	AttachmentStatus types.AttachmentStatus

	// The time when the registration attachment was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The Amazon Resource Name (ARN) for the registration attachment.
	//
	// This member is required.
	RegistrationAttachmentArn *string

	// The unique identifier for the registration attachment.
	//
	// This member is required.
	RegistrationAttachmentId *string

	// The error message if the upload failed.
	AttachmentUploadErrorReason types.AttachmentUploadErrorReason

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRegistrationFieldValueInput 

type DeleteRegistrationFieldValueInput struct {

	// The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
	//
	// This member is required.
	FieldPath *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string
	// contains filtered or unexported fields
}

type DeleteRegistrationFieldValueOutput 

type DeleteRegistrationFieldValueOutput struct {

	// The path to the registration form field.
	//
	// This member is required.
	FieldPath *string

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The version number of the registration.
	//
	// This member is required.
	VersionNumber *int64

	// The unique identifier for the registration attachment.
	RegistrationAttachmentId *string

	// An array of values for the form field.
	SelectChoices []string

	// The text data for a free form field.
	TextValue *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRegistrationInput 

type DeleteRegistrationInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string
	// contains filtered or unexported fields
}

type DeleteRegistrationOutput 

type DeleteRegistrationOutput struct {

	// The time when the registration was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The current version number of the registration.
	//
	// This member is required.
	CurrentVersionNumber *int64

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The status of the registration.
	//
	//   - CREATED : Your registration is created but not submitted.
	//
	//   - SUBMITTED : Your registration has been submitted and is awaiting review.
	//
	//   - REVIEWING : Your registration has been accepted and is being reviewed.
	//
	//   - PROVISIONING : Your registration has been approved and your origination
	//   identity is being created.
	//
	//   - COMPLETE : Your registration has been approved and and your origination
	//   identity has been created.
	//
	//   - REQUIRES_UPDATES : You must fix your registration and resubmit it.
	//
	//   - CLOSED : The phone number or sender ID has been deleted and you must also
	//   delete the registration for the number.
	//
	//   - DELETED : The registration has been deleted.
	//
	// This member is required.
	RegistrationStatus types.RegistrationStatus

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// Metadata about a given registration which is specific to that registration type.
	AdditionalAttributes map[string]string

	// The version number of the registration that was approved.
	ApprovedVersionNumber *int64

	// The latest version number of the registration that was denied.
	LatestDeniedVersionNumber *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTextMessageSpendLimitOverrideInput 

type DeleteTextMessageSpendLimitOverrideInput struct {
	// contains filtered or unexported fields
}

type DeleteTextMessageSpendLimitOverrideOutput 

type DeleteTextMessageSpendLimitOverrideOutput struct {

	// The current monthly limit, in US dollars.
	MonthlyLimit *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVerifiedDestinationNumberInput 

type DeleteVerifiedDestinationNumberInput struct {

	// The unique identifier for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberId *string
	// contains filtered or unexported fields
}

type DeleteVerifiedDestinationNumberOutput 

type DeleteVerifiedDestinationNumberOutput struct {

	// The time when the destination phone number was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The verified destination phone number, in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// The Amazon Resource Name (ARN) for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberArn *string

	// The unique identifier for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVoiceMessageSpendLimitOverrideInput 

type DeleteVoiceMessageSpendLimitOverrideInput struct {
	// contains filtered or unexported fields
}

type DeleteVoiceMessageSpendLimitOverrideOutput 

type DeleteVoiceMessageSpendLimitOverrideOutput struct {

	// The current monthly limit, in US dollars.
	MonthlyLimit *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountAttributesAPIClient 

type DescribeAccountAttributesAPIClient interface {
	DescribeAccountAttributes(context.Context, *DescribeAccountAttributesInput, ...func(*Options)) (*DescribeAccountAttributesOutput, error)
}

DescribeAccountAttributesAPIClient is a client that implements the DescribeAccountAttributes operation.

type DescribeAccountAttributesInput 

type DescribeAccountAttributesInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeAccountAttributesOutput 

type DescribeAccountAttributesOutput struct {

	// An array of AccountAttributes objects.
	AccountAttributes []types.AccountAttribute

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountAttributesPaginator 

type DescribeAccountAttributesPaginator struct {
	// contains filtered or unexported fields
}

DescribeAccountAttributesPaginator is a paginator for DescribeAccountAttributes

func NewDescribeAccountAttributesPaginator 

func NewDescribeAccountAttributesPaginator(client DescribeAccountAttributesAPIClient, params *DescribeAccountAttributesInput, optFns ...func(*DescribeAccountAttributesPaginatorOptions)) *DescribeAccountAttributesPaginator

NewDescribeAccountAttributesPaginator returns a new DescribeAccountAttributesPaginator

func (*DescribeAccountAttributesPaginator) HasMorePages 

func (p *DescribeAccountAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeAccountAttributesPaginator) NextPage 

func (p *DescribeAccountAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error)

NextPage retrieves the next DescribeAccountAttributes page.

type DescribeAccountAttributesPaginatorOptions 

type DescribeAccountAttributesPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeAccountAttributesPaginatorOptions is the paginator options for DescribeAccountAttributes

type DescribeAccountLimitsAPIClient 

type DescribeAccountLimitsAPIClient interface {
	DescribeAccountLimits(context.Context, *DescribeAccountLimitsInput, ...func(*Options)) (*DescribeAccountLimitsOutput, error)
}

DescribeAccountLimitsAPIClient is a client that implements the DescribeAccountLimits operation.

type DescribeAccountLimitsInput 

type DescribeAccountLimitsInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeAccountLimitsOutput 

type DescribeAccountLimitsOutput struct {

	// An array of AccountLimit objects that show the current spend limits.
	AccountLimits []types.AccountLimit

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountLimitsPaginator 

type DescribeAccountLimitsPaginator struct {
	// contains filtered or unexported fields
}

DescribeAccountLimitsPaginator is a paginator for DescribeAccountLimits

func NewDescribeAccountLimitsPaginator 

func NewDescribeAccountLimitsPaginator(client DescribeAccountLimitsAPIClient, params *DescribeAccountLimitsInput, optFns ...func(*DescribeAccountLimitsPaginatorOptions)) *DescribeAccountLimitsPaginator

NewDescribeAccountLimitsPaginator returns a new DescribeAccountLimitsPaginator

func (*DescribeAccountLimitsPaginator) HasMorePages 

func (p *DescribeAccountLimitsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeAccountLimitsPaginator) NextPage 

func (p *DescribeAccountLimitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error)

NextPage retrieves the next DescribeAccountLimits page.

type DescribeAccountLimitsPaginatorOptions 

type DescribeAccountLimitsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeAccountLimitsPaginatorOptions is the paginator options for DescribeAccountLimits

type DescribeConfigurationSetsAPIClient 

type DescribeConfigurationSetsAPIClient interface {
	DescribeConfigurationSets(context.Context, *DescribeConfigurationSetsInput, ...func(*Options)) (*DescribeConfigurationSetsOutput, error)
}

DescribeConfigurationSetsAPIClient is a client that implements the DescribeConfigurationSets operation.

type DescribeConfigurationSetsInput 

type DescribeConfigurationSetsInput struct {

	// An array of strings. Each element can be either a ConfigurationSetName or
	// ConfigurationSetArn.
	ConfigurationSetNames []string

	// An array of filters to apply to the results that are returned.
	Filters []types.ConfigurationSetFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeConfigurationSetsOutput 

type DescribeConfigurationSetsOutput struct {

	// An array of ConfigurationSets objects.
	ConfigurationSets []types.ConfigurationSetInformation

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeConfigurationSetsPaginator 

type DescribeConfigurationSetsPaginator struct {
	// contains filtered or unexported fields
}

DescribeConfigurationSetsPaginator is a paginator for DescribeConfigurationSets

func NewDescribeConfigurationSetsPaginator 

func NewDescribeConfigurationSetsPaginator(client DescribeConfigurationSetsAPIClient, params *DescribeConfigurationSetsInput, optFns ...func(*DescribeConfigurationSetsPaginatorOptions)) *DescribeConfigurationSetsPaginator

NewDescribeConfigurationSetsPaginator returns a new DescribeConfigurationSetsPaginator

func (*DescribeConfigurationSetsPaginator) HasMorePages 

func (p *DescribeConfigurationSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeConfigurationSetsPaginator) NextPage 

func (p *DescribeConfigurationSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeConfigurationSetsOutput, error)

NextPage retrieves the next DescribeConfigurationSets page.

type DescribeConfigurationSetsPaginatorOptions 

type DescribeConfigurationSetsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeConfigurationSetsPaginatorOptions is the paginator options for DescribeConfigurationSets

type DescribeKeywordsAPIClient 

type DescribeKeywordsAPIClient interface {
	DescribeKeywords(context.Context, *DescribeKeywordsInput, ...func(*Options)) (*DescribeKeywordsOutput, error)
}

DescribeKeywordsAPIClient is a client that implements the DescribeKeywords operation.

type DescribeKeywordsInput 

type DescribeKeywordsInput struct {

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbersto find the values for PhoneNumberId and
	// PhoneNumberArn while DescribeSenderIdscan be used to get the values for SenderId and SenderIdArn.
	//
	// This member is required.
	OriginationIdentity *string

	// An array of keyword filters to filter the results.
	Filters []types.KeywordFilter

	// An array of keywords to search for.
	Keywords []string

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeKeywordsOutput 

type DescribeKeywordsOutput struct {

	// An array of KeywordInformation objects that contain the results.
	Keywords []types.KeywordInformation

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
	OriginationIdentity *string

	// The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
	OriginationIdentityArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeKeywordsPaginator 

type DescribeKeywordsPaginator struct {
	// contains filtered or unexported fields
}

DescribeKeywordsPaginator is a paginator for DescribeKeywords

func NewDescribeKeywordsPaginator 

func NewDescribeKeywordsPaginator(client DescribeKeywordsAPIClient, params *DescribeKeywordsInput, optFns ...func(*DescribeKeywordsPaginatorOptions)) *DescribeKeywordsPaginator

NewDescribeKeywordsPaginator returns a new DescribeKeywordsPaginator

func (*DescribeKeywordsPaginator) HasMorePages 

func (p *DescribeKeywordsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeKeywordsPaginator) NextPage 

func (p *DescribeKeywordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeKeywordsOutput, error)

NextPage retrieves the next DescribeKeywords page.

type DescribeKeywordsPaginatorOptions 

type DescribeKeywordsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeKeywordsPaginatorOptions is the paginator options for DescribeKeywords

type DescribeOptOutListsAPIClient 

type DescribeOptOutListsAPIClient interface {
	DescribeOptOutLists(context.Context, *DescribeOptOutListsInput, ...func(*Options)) (*DescribeOptOutListsOutput, error)
}

DescribeOptOutListsAPIClient is a client that implements the DescribeOptOutLists operation.

type DescribeOptOutListsInput 

type DescribeOptOutListsInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The OptOutLists to show the details of. This is an array of strings that can be
	// either the OptOutListName or OptOutListArn.
	OptOutListNames []string
	// contains filtered or unexported fields
}

type DescribeOptOutListsOutput 

type DescribeOptOutListsOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// An array of OptOutListInformation objects that contain the details for the
	// requested OptOutLists.
	OptOutLists []types.OptOutListInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeOptOutListsPaginator 

type DescribeOptOutListsPaginator struct {
	// contains filtered or unexported fields
}

DescribeOptOutListsPaginator is a paginator for DescribeOptOutLists

func NewDescribeOptOutListsPaginator 

func NewDescribeOptOutListsPaginator(client DescribeOptOutListsAPIClient, params *DescribeOptOutListsInput, optFns ...func(*DescribeOptOutListsPaginatorOptions)) *DescribeOptOutListsPaginator

NewDescribeOptOutListsPaginator returns a new DescribeOptOutListsPaginator

func (*DescribeOptOutListsPaginator) HasMorePages 

func (p *DescribeOptOutListsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeOptOutListsPaginator) NextPage 

func (p *DescribeOptOutListsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOptOutListsOutput, error)

NextPage retrieves the next DescribeOptOutLists page.

type DescribeOptOutListsPaginatorOptions 

type DescribeOptOutListsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeOptOutListsPaginatorOptions is the paginator options for DescribeOptOutLists

type DescribeOptedOutNumbersAPIClient 

type DescribeOptedOutNumbersAPIClient interface {
	DescribeOptedOutNumbers(context.Context, *DescribeOptedOutNumbersInput, ...func(*Options)) (*DescribeOptedOutNumbersOutput, error)
}

DescribeOptedOutNumbersAPIClient is a client that implements the DescribeOptedOutNumbers operation.

type DescribeOptedOutNumbersInput 

type DescribeOptedOutNumbersInput struct {

	// The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the
	// values for OptOutListName and OptOutListArn.
	//
	// This member is required.
	OptOutListName *string

	// An array of OptedOutFilter objects to filter the results on.
	Filters []types.OptedOutFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of phone numbers to search for in the OptOutList.
	OptedOutNumbers []string
	// contains filtered or unexported fields
}

type DescribeOptedOutNumbersOutput 

type DescribeOptedOutNumbersOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// The Amazon Resource Name (ARN) of the OptOutList.
	OptOutListArn *string

	// The name of the OptOutList.
	OptOutListName *string

	// An array of OptedOutNumbersInformation objects that provide information about
	// the requested OptedOutNumbers.
	OptedOutNumbers []types.OptedOutNumberInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeOptedOutNumbersPaginator 

type DescribeOptedOutNumbersPaginator struct {
	// contains filtered or unexported fields
}

DescribeOptedOutNumbersPaginator is a paginator for DescribeOptedOutNumbers

func NewDescribeOptedOutNumbersPaginator 

func NewDescribeOptedOutNumbersPaginator(client DescribeOptedOutNumbersAPIClient, params *DescribeOptedOutNumbersInput, optFns ...func(*DescribeOptedOutNumbersPaginatorOptions)) *DescribeOptedOutNumbersPaginator

NewDescribeOptedOutNumbersPaginator returns a new DescribeOptedOutNumbersPaginator

func (*DescribeOptedOutNumbersPaginator) HasMorePages 

func (p *DescribeOptedOutNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeOptedOutNumbersPaginator) NextPage 

func (p *DescribeOptedOutNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOptedOutNumbersOutput, error)

NextPage retrieves the next DescribeOptedOutNumbers page.

type DescribeOptedOutNumbersPaginatorOptions 

type DescribeOptedOutNumbersPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeOptedOutNumbersPaginatorOptions is the paginator options for DescribeOptedOutNumbers

type DescribePhoneNumbersAPIClient 

type DescribePhoneNumbersAPIClient interface {
	DescribePhoneNumbers(context.Context, *DescribePhoneNumbersInput, ...func(*Options)) (*DescribePhoneNumbersOutput, error)
}

DescribePhoneNumbersAPIClient is a client that implements the DescribePhoneNumbers operation.

type DescribePhoneNumbersInput 

type DescribePhoneNumbersInput struct {

	// An array of PhoneNumberFilter objects to filter the results.
	Filters []types.PhoneNumberFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The unique identifier of phone numbers to find information about. This is an
	// array of strings that can be either the PhoneNumberId or PhoneNumberArn.
	PhoneNumberIds []string
	// contains filtered or unexported fields
}

type DescribePhoneNumbersOutput 

type DescribePhoneNumbersOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// An array of PhoneNumberInformation objects that contain the details for the
	// requested phone numbers.
	PhoneNumbers []types.PhoneNumberInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePhoneNumbersPaginator 

type DescribePhoneNumbersPaginator struct {
	// contains filtered or unexported fields
}

DescribePhoneNumbersPaginator is a paginator for DescribePhoneNumbers

func NewDescribePhoneNumbersPaginator 

func NewDescribePhoneNumbersPaginator(client DescribePhoneNumbersAPIClient, params *DescribePhoneNumbersInput, optFns ...func(*DescribePhoneNumbersPaginatorOptions)) *DescribePhoneNumbersPaginator

NewDescribePhoneNumbersPaginator returns a new DescribePhoneNumbersPaginator

func (*DescribePhoneNumbersPaginator) HasMorePages 

func (p *DescribePhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribePhoneNumbersPaginator) NextPage 

func (p *DescribePhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePhoneNumbersOutput, error)

NextPage retrieves the next DescribePhoneNumbers page.

type DescribePhoneNumbersPaginatorOptions 

type DescribePhoneNumbersPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribePhoneNumbersPaginatorOptions is the paginator options for DescribePhoneNumbers

type DescribePoolsAPIClient 

type DescribePoolsAPIClient interface {
	DescribePools(context.Context, *DescribePoolsInput, ...func(*Options)) (*DescribePoolsOutput, error)
}

DescribePoolsAPIClient is a client that implements the DescribePools operation.

type DescribePoolsInput 

type DescribePoolsInput struct {

	// An array of PoolFilter objects to filter the results.
	Filters []types.PoolFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The unique identifier of pools to find. This is an array of strings that can be
	// either the PoolId or PoolArn.
	PoolIds []string
	// contains filtered or unexported fields
}

type DescribePoolsOutput 

type DescribePoolsOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// An array of PoolInformation objects that contain the details for the requested
	// pools.
	Pools []types.PoolInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePoolsPaginator 

type DescribePoolsPaginator struct {
	// contains filtered or unexported fields
}

DescribePoolsPaginator is a paginator for DescribePools

func NewDescribePoolsPaginator 

func NewDescribePoolsPaginator(client DescribePoolsAPIClient, params *DescribePoolsInput, optFns ...func(*DescribePoolsPaginatorOptions)) *DescribePoolsPaginator

NewDescribePoolsPaginator returns a new DescribePoolsPaginator

func (*DescribePoolsPaginator) HasMorePages 

func (p *DescribePoolsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribePoolsPaginator) NextPage 

func (p *DescribePoolsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePoolsOutput, error)

NextPage retrieves the next DescribePools page.

type DescribePoolsPaginatorOptions 

type DescribePoolsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribePoolsPaginatorOptions is the paginator options for DescribePools

type DescribeProtectConfigurationsAPIClient 

type DescribeProtectConfigurationsAPIClient interface {
	DescribeProtectConfigurations(context.Context, *DescribeProtectConfigurationsInput, ...func(*Options)) (*DescribeProtectConfigurationsOutput, error)
}

DescribeProtectConfigurationsAPIClient is a client that implements the DescribeProtectConfigurations operation.

type DescribeProtectConfigurationsInput 

type DescribeProtectConfigurationsInput struct {

	// An array of ProtectConfigurationFilter objects to filter the results.
	Filters []types.ProtectConfigurationFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of protect configuration identifiers to search for.
	ProtectConfigurationIds []string
	// contains filtered or unexported fields
}

type DescribeProtectConfigurationsOutput 

type DescribeProtectConfigurationsOutput struct {

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of ProtectConfigurationInformation objects that contain the details
	// for the request.
	ProtectConfigurations []types.ProtectConfigurationInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProtectConfigurationsPaginator 

type DescribeProtectConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

DescribeProtectConfigurationsPaginator is a paginator for DescribeProtectConfigurations

func NewDescribeProtectConfigurationsPaginator 

func NewDescribeProtectConfigurationsPaginator(client DescribeProtectConfigurationsAPIClient, params *DescribeProtectConfigurationsInput, optFns ...func(*DescribeProtectConfigurationsPaginatorOptions)) *DescribeProtectConfigurationsPaginator

NewDescribeProtectConfigurationsPaginator returns a new DescribeProtectConfigurationsPaginator

func (*DescribeProtectConfigurationsPaginator) HasMorePages 

func (p *DescribeProtectConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeProtectConfigurationsPaginator) NextPage 

func (p *DescribeProtectConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeProtectConfigurationsOutput, error)

NextPage retrieves the next DescribeProtectConfigurations page.

type DescribeProtectConfigurationsPaginatorOptions 

type DescribeProtectConfigurationsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeProtectConfigurationsPaginatorOptions is the paginator options for DescribeProtectConfigurations

type DescribeRegistrationAttachmentsAPIClient 

type DescribeRegistrationAttachmentsAPIClient interface {
	DescribeRegistrationAttachments(context.Context, *DescribeRegistrationAttachmentsInput, ...func(*Options)) (*DescribeRegistrationAttachmentsOutput, error)
}

DescribeRegistrationAttachmentsAPIClient is a client that implements the DescribeRegistrationAttachments operation.

type DescribeRegistrationAttachmentsInput 

type DescribeRegistrationAttachmentsInput struct {

	// An array of RegistrationAttachmentFilter objects to filter the results.
	Filters []types.RegistrationAttachmentFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The unique identifier of registration attachments to find. This is an array of
	// RegistrationAttachmentId.
	RegistrationAttachmentIds []string
	// contains filtered or unexported fields
}

type DescribeRegistrationAttachmentsOutput 

type DescribeRegistrationAttachmentsOutput struct {

	// An array of RegistrationAttachments objects that contain the details for the
	// requested registration attachments.
	//
	// This member is required.
	RegistrationAttachments []types.RegistrationAttachmentsInformation

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationAttachmentsPaginator 

type DescribeRegistrationAttachmentsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationAttachmentsPaginator is a paginator for DescribeRegistrationAttachments

func NewDescribeRegistrationAttachmentsPaginator 

func NewDescribeRegistrationAttachmentsPaginator(client DescribeRegistrationAttachmentsAPIClient, params *DescribeRegistrationAttachmentsInput, optFns ...func(*DescribeRegistrationAttachmentsPaginatorOptions)) *DescribeRegistrationAttachmentsPaginator

NewDescribeRegistrationAttachmentsPaginator returns a new DescribeRegistrationAttachmentsPaginator

func (*DescribeRegistrationAttachmentsPaginator) HasMorePages 

func (p *DescribeRegistrationAttachmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationAttachmentsPaginator) NextPage 

func (p *DescribeRegistrationAttachmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationAttachmentsOutput, error)

NextPage retrieves the next DescribeRegistrationAttachments page.

type DescribeRegistrationAttachmentsPaginatorOptions 

type DescribeRegistrationAttachmentsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationAttachmentsPaginatorOptions is the paginator options for DescribeRegistrationAttachments

type DescribeRegistrationFieldDefinitionsAPIClient 

type DescribeRegistrationFieldDefinitionsAPIClient interface {
	DescribeRegistrationFieldDefinitions(context.Context, *DescribeRegistrationFieldDefinitionsInput, ...func(*Options)) (*DescribeRegistrationFieldDefinitionsOutput, error)
}

DescribeRegistrationFieldDefinitionsAPIClient is a client that implements the DescribeRegistrationFieldDefinitions operation.

type DescribeRegistrationFieldDefinitionsInput 

type DescribeRegistrationFieldDefinitionsInput struct {

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// An array of paths to the registration form field.
	FieldPaths []string

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The path to the section of the registration.
	SectionPath *string
	// contains filtered or unexported fields
}

type DescribeRegistrationFieldDefinitionsOutput 

type DescribeRegistrationFieldDefinitionsOutput struct {

	// An array of RegistrationFieldDefinitions objects that contain the details for
	// the requested fields.
	//
	// This member is required.
	RegistrationFieldDefinitions []types.RegistrationFieldDefinition

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationFieldDefinitionsPaginator 

type DescribeRegistrationFieldDefinitionsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationFieldDefinitionsPaginator is a paginator for DescribeRegistrationFieldDefinitions

func NewDescribeRegistrationFieldDefinitionsPaginator 

func NewDescribeRegistrationFieldDefinitionsPaginator(client DescribeRegistrationFieldDefinitionsAPIClient, params *DescribeRegistrationFieldDefinitionsInput, optFns ...func(*DescribeRegistrationFieldDefinitionsPaginatorOptions)) *DescribeRegistrationFieldDefinitionsPaginator

NewDescribeRegistrationFieldDefinitionsPaginator returns a new DescribeRegistrationFieldDefinitionsPaginator

func (*DescribeRegistrationFieldDefinitionsPaginator) HasMorePages 

func (p *DescribeRegistrationFieldDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationFieldDefinitionsPaginator) NextPage 

func (p *DescribeRegistrationFieldDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationFieldDefinitionsOutput, error)

NextPage retrieves the next DescribeRegistrationFieldDefinitions page.

type DescribeRegistrationFieldDefinitionsPaginatorOptions 

type DescribeRegistrationFieldDefinitionsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationFieldDefinitionsPaginatorOptions is the paginator options for DescribeRegistrationFieldDefinitions

type DescribeRegistrationFieldValuesAPIClient 

type DescribeRegistrationFieldValuesAPIClient interface {
	DescribeRegistrationFieldValues(context.Context, *DescribeRegistrationFieldValuesInput, ...func(*Options)) (*DescribeRegistrationFieldValuesOutput, error)
}

DescribeRegistrationFieldValuesAPIClient is a client that implements the DescribeRegistrationFieldValues operation.

type DescribeRegistrationFieldValuesInput 

type DescribeRegistrationFieldValuesInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// An array of paths to the registration form field.
	FieldPaths []string

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The path to the section of the registration.
	SectionPath *string

	// The version number of the registration.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DescribeRegistrationFieldValuesOutput 

type DescribeRegistrationFieldValuesOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// An array of RegistrationFieldValues objects that contain the values for the
	// requested registration.
	//
	// This member is required.
	RegistrationFieldValues []types.RegistrationFieldValueInformation

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The current version of the registration.
	//
	// This member is required.
	VersionNumber *int64

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationFieldValuesPaginator 

type DescribeRegistrationFieldValuesPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationFieldValuesPaginator is a paginator for DescribeRegistrationFieldValues

func NewDescribeRegistrationFieldValuesPaginator 

func NewDescribeRegistrationFieldValuesPaginator(client DescribeRegistrationFieldValuesAPIClient, params *DescribeRegistrationFieldValuesInput, optFns ...func(*DescribeRegistrationFieldValuesPaginatorOptions)) *DescribeRegistrationFieldValuesPaginator

NewDescribeRegistrationFieldValuesPaginator returns a new DescribeRegistrationFieldValuesPaginator

func (*DescribeRegistrationFieldValuesPaginator) HasMorePages 

func (p *DescribeRegistrationFieldValuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationFieldValuesPaginator) NextPage 

func (p *DescribeRegistrationFieldValuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationFieldValuesOutput, error)

NextPage retrieves the next DescribeRegistrationFieldValues page.

type DescribeRegistrationFieldValuesPaginatorOptions 

type DescribeRegistrationFieldValuesPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationFieldValuesPaginatorOptions is the paginator options for DescribeRegistrationFieldValues

type DescribeRegistrationSectionDefinitionsAPIClient 

type DescribeRegistrationSectionDefinitionsAPIClient interface {
	DescribeRegistrationSectionDefinitions(context.Context, *DescribeRegistrationSectionDefinitionsInput, ...func(*Options)) (*DescribeRegistrationSectionDefinitionsOutput, error)
}

DescribeRegistrationSectionDefinitionsAPIClient is a client that implements the DescribeRegistrationSectionDefinitions operation.

type DescribeRegistrationSectionDefinitionsInput 

type DescribeRegistrationSectionDefinitionsInput struct {

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of paths for the registration form section.
	SectionPaths []string
	// contains filtered or unexported fields
}

type DescribeRegistrationSectionDefinitionsOutput 

type DescribeRegistrationSectionDefinitionsOutput struct {

	// An array of RegistrationSectionDefinition objects.
	//
	// This member is required.
	RegistrationSectionDefinitions []types.RegistrationSectionDefinition

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationSectionDefinitionsPaginator 

type DescribeRegistrationSectionDefinitionsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationSectionDefinitionsPaginator is a paginator for DescribeRegistrationSectionDefinitions

func NewDescribeRegistrationSectionDefinitionsPaginator 

func NewDescribeRegistrationSectionDefinitionsPaginator(client DescribeRegistrationSectionDefinitionsAPIClient, params *DescribeRegistrationSectionDefinitionsInput, optFns ...func(*DescribeRegistrationSectionDefinitionsPaginatorOptions)) *DescribeRegistrationSectionDefinitionsPaginator

NewDescribeRegistrationSectionDefinitionsPaginator returns a new DescribeRegistrationSectionDefinitionsPaginator

func (*DescribeRegistrationSectionDefinitionsPaginator) HasMorePages 

func (p *DescribeRegistrationSectionDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationSectionDefinitionsPaginator) NextPage 

func (p *DescribeRegistrationSectionDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationSectionDefinitionsOutput, error)

NextPage retrieves the next DescribeRegistrationSectionDefinitions page.

type DescribeRegistrationSectionDefinitionsPaginatorOptions 

type DescribeRegistrationSectionDefinitionsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationSectionDefinitionsPaginatorOptions is the paginator options for DescribeRegistrationSectionDefinitions

type DescribeRegistrationTypeDefinitionsAPIClient 

type DescribeRegistrationTypeDefinitionsAPIClient interface {
	DescribeRegistrationTypeDefinitions(context.Context, *DescribeRegistrationTypeDefinitionsInput, ...func(*Options)) (*DescribeRegistrationTypeDefinitionsOutput, error)
}

DescribeRegistrationTypeDefinitionsAPIClient is a client that implements the DescribeRegistrationTypeDefinitions operation.

type DescribeRegistrationTypeDefinitionsInput 

type DescribeRegistrationTypeDefinitionsInput struct {

	// An array of RegistrationFilter objects to filter the results.
	Filters []types.RegistrationTypeFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	RegistrationTypes []string
	// contains filtered or unexported fields
}

type DescribeRegistrationTypeDefinitionsOutput 

type DescribeRegistrationTypeDefinitionsOutput struct {

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationTypeDefinitions []types.RegistrationTypeDefinition

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationTypeDefinitionsPaginator 

type DescribeRegistrationTypeDefinitionsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationTypeDefinitionsPaginator is a paginator for DescribeRegistrationTypeDefinitions

func NewDescribeRegistrationTypeDefinitionsPaginator 

func NewDescribeRegistrationTypeDefinitionsPaginator(client DescribeRegistrationTypeDefinitionsAPIClient, params *DescribeRegistrationTypeDefinitionsInput, optFns ...func(*DescribeRegistrationTypeDefinitionsPaginatorOptions)) *DescribeRegistrationTypeDefinitionsPaginator

NewDescribeRegistrationTypeDefinitionsPaginator returns a new DescribeRegistrationTypeDefinitionsPaginator

func (*DescribeRegistrationTypeDefinitionsPaginator) HasMorePages 

func (p *DescribeRegistrationTypeDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationTypeDefinitionsPaginator) NextPage 

func (p *DescribeRegistrationTypeDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationTypeDefinitionsOutput, error)

NextPage retrieves the next DescribeRegistrationTypeDefinitions page.

type DescribeRegistrationTypeDefinitionsPaginatorOptions 

type DescribeRegistrationTypeDefinitionsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationTypeDefinitionsPaginatorOptions is the paginator options for DescribeRegistrationTypeDefinitions

type DescribeRegistrationVersionsAPIClient 

type DescribeRegistrationVersionsAPIClient interface {
	DescribeRegistrationVersions(context.Context, *DescribeRegistrationVersionsInput, ...func(*Options)) (*DescribeRegistrationVersionsOutput, error)
}

DescribeRegistrationVersionsAPIClient is a client that implements the DescribeRegistrationVersions operation.

type DescribeRegistrationVersionsInput 

type DescribeRegistrationVersionsInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// An array of RegistrationVersionFilter objects to filter the results.
	Filters []types.RegistrationVersionFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of registration version numbers.
	VersionNumbers []int64
	// contains filtered or unexported fields
}

type DescribeRegistrationVersionsOutput 

type DescribeRegistrationVersionsOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// An array of RegistrationVersions objects.
	//
	// This member is required.
	RegistrationVersions []types.RegistrationVersionInformation

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationVersionsPaginator 

type DescribeRegistrationVersionsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationVersionsPaginator is a paginator for DescribeRegistrationVersions

func NewDescribeRegistrationVersionsPaginator 

func NewDescribeRegistrationVersionsPaginator(client DescribeRegistrationVersionsAPIClient, params *DescribeRegistrationVersionsInput, optFns ...func(*DescribeRegistrationVersionsPaginatorOptions)) *DescribeRegistrationVersionsPaginator

NewDescribeRegistrationVersionsPaginator returns a new DescribeRegistrationVersionsPaginator

func (*DescribeRegistrationVersionsPaginator) HasMorePages 

func (p *DescribeRegistrationVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationVersionsPaginator) NextPage 

func (p *DescribeRegistrationVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationVersionsOutput, error)

NextPage retrieves the next DescribeRegistrationVersions page.

type DescribeRegistrationVersionsPaginatorOptions 

type DescribeRegistrationVersionsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationVersionsPaginatorOptions is the paginator options for DescribeRegistrationVersions

type DescribeRegistrationsAPIClient 

type DescribeRegistrationsAPIClient interface {
	DescribeRegistrations(context.Context, *DescribeRegistrationsInput, ...func(*Options)) (*DescribeRegistrationsOutput, error)
}

DescribeRegistrationsAPIClient is a client that implements the DescribeRegistrations operation.

type DescribeRegistrationsInput 

type DescribeRegistrationsInput struct {

	// An array of RegistrationFilter objects to filter the results.
	Filters []types.RegistrationFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of unique identifiers for each registration.
	RegistrationIds []string
	// contains filtered or unexported fields
}

type DescribeRegistrationsOutput 

type DescribeRegistrationsOutput struct {

	// An array of RegistrationInformation objects.
	//
	// This member is required.
	Registrations []types.RegistrationInformation

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegistrationsPaginator 

type DescribeRegistrationsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegistrationsPaginator is a paginator for DescribeRegistrations

func NewDescribeRegistrationsPaginator 

func NewDescribeRegistrationsPaginator(client DescribeRegistrationsAPIClient, params *DescribeRegistrationsInput, optFns ...func(*DescribeRegistrationsPaginatorOptions)) *DescribeRegistrationsPaginator

NewDescribeRegistrationsPaginator returns a new DescribeRegistrationsPaginator

func (*DescribeRegistrationsPaginator) HasMorePages 

func (p *DescribeRegistrationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegistrationsPaginator) NextPage 

func (p *DescribeRegistrationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistrationsOutput, error)

NextPage retrieves the next DescribeRegistrations page.

type DescribeRegistrationsPaginatorOptions 

type DescribeRegistrationsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegistrationsPaginatorOptions is the paginator options for DescribeRegistrations

type DescribeSenderIdsAPIClient 

type DescribeSenderIdsAPIClient interface {
	DescribeSenderIds(context.Context, *DescribeSenderIdsInput, ...func(*Options)) (*DescribeSenderIdsOutput, error)
}

DescribeSenderIdsAPIClient is a client that implements the DescribeSenderIds operation.

type DescribeSenderIdsInput 

type DescribeSenderIdsInput struct {

	// An array of SenderIdFilter objects to filter the results.
	Filters []types.SenderIdFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of SenderIdAndCountry objects to search for.
	SenderIds []types.SenderIdAndCountry
	// contains filtered or unexported fields
}

type DescribeSenderIdsOutput 

type DescribeSenderIdsOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// An array of SernderIdInformation objects that contain the details for the
	// requested SenderIds.
	SenderIds []types.SenderIdInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSenderIdsPaginator 

type DescribeSenderIdsPaginator struct {
	// contains filtered or unexported fields
}

DescribeSenderIdsPaginator is a paginator for DescribeSenderIds

func NewDescribeSenderIdsPaginator 

func NewDescribeSenderIdsPaginator(client DescribeSenderIdsAPIClient, params *DescribeSenderIdsInput, optFns ...func(*DescribeSenderIdsPaginatorOptions)) *DescribeSenderIdsPaginator

NewDescribeSenderIdsPaginator returns a new DescribeSenderIdsPaginator

func (*DescribeSenderIdsPaginator) HasMorePages 

func (p *DescribeSenderIdsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSenderIdsPaginator) NextPage 

func (p *DescribeSenderIdsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSenderIdsOutput, error)

NextPage retrieves the next DescribeSenderIds page.

type DescribeSenderIdsPaginatorOptions 

type DescribeSenderIdsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeSenderIdsPaginatorOptions is the paginator options for DescribeSenderIds

type DescribeSpendLimitsAPIClient 

type DescribeSpendLimitsAPIClient interface {
	DescribeSpendLimits(context.Context, *DescribeSpendLimitsInput, ...func(*Options)) (*DescribeSpendLimitsOutput, error)
}

DescribeSpendLimitsAPIClient is a client that implements the DescribeSpendLimits operation.

type DescribeSpendLimitsInput 

type DescribeSpendLimitsInput struct {

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeSpendLimitsOutput 

type DescribeSpendLimitsOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// An array of SpendLimit objects that contain the details for the requested spend
	// limits.
	SpendLimits []types.SpendLimit

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSpendLimitsPaginator 

type DescribeSpendLimitsPaginator struct {
	// contains filtered or unexported fields
}

DescribeSpendLimitsPaginator is a paginator for DescribeSpendLimits

func NewDescribeSpendLimitsPaginator 

func NewDescribeSpendLimitsPaginator(client DescribeSpendLimitsAPIClient, params *DescribeSpendLimitsInput, optFns ...func(*DescribeSpendLimitsPaginatorOptions)) *DescribeSpendLimitsPaginator

NewDescribeSpendLimitsPaginator returns a new DescribeSpendLimitsPaginator

func (*DescribeSpendLimitsPaginator) HasMorePages 

func (p *DescribeSpendLimitsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSpendLimitsPaginator) NextPage 

func (p *DescribeSpendLimitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSpendLimitsOutput, error)

NextPage retrieves the next DescribeSpendLimits page.

type DescribeSpendLimitsPaginatorOptions 

type DescribeSpendLimitsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeSpendLimitsPaginatorOptions is the paginator options for DescribeSpendLimits

type DescribeVerifiedDestinationNumbersAPIClient 

type DescribeVerifiedDestinationNumbersAPIClient interface {
	DescribeVerifiedDestinationNumbers(context.Context, *DescribeVerifiedDestinationNumbersInput, ...func(*Options)) (*DescribeVerifiedDestinationNumbersOutput, error)
}

DescribeVerifiedDestinationNumbersAPIClient is a client that implements the DescribeVerifiedDestinationNumbers operation.

type DescribeVerifiedDestinationNumbersInput 

type DescribeVerifiedDestinationNumbersInput struct {

	// An array of verified destination phone number, in E.164 format.
	DestinationPhoneNumbers []string

	// An array of VerifiedDestinationNumberFilter objects to filter the results.
	Filters []types.VerifiedDestinationNumberFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// An array of VerifiedDestinationNumberid to retreive.
	VerifiedDestinationNumberIds []string
	// contains filtered or unexported fields
}

type DescribeVerifiedDestinationNumbersOutput 

type DescribeVerifiedDestinationNumbersOutput struct {

	// An array of VerifiedDestinationNumberInformation objects
	//
	// This member is required.
	VerifiedDestinationNumbers []types.VerifiedDestinationNumberInformation

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeVerifiedDestinationNumbersPaginator 

type DescribeVerifiedDestinationNumbersPaginator struct {
	// contains filtered or unexported fields
}

DescribeVerifiedDestinationNumbersPaginator is a paginator for DescribeVerifiedDestinationNumbers

func NewDescribeVerifiedDestinationNumbersPaginator 

func NewDescribeVerifiedDestinationNumbersPaginator(client DescribeVerifiedDestinationNumbersAPIClient, params *DescribeVerifiedDestinationNumbersInput, optFns ...func(*DescribeVerifiedDestinationNumbersPaginatorOptions)) *DescribeVerifiedDestinationNumbersPaginator

NewDescribeVerifiedDestinationNumbersPaginator returns a new DescribeVerifiedDestinationNumbersPaginator

func (*DescribeVerifiedDestinationNumbersPaginator) HasMorePages 

func (p *DescribeVerifiedDestinationNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeVerifiedDestinationNumbersPaginator) NextPage 

func (p *DescribeVerifiedDestinationNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeVerifiedDestinationNumbersOutput, error)

NextPage retrieves the next DescribeVerifiedDestinationNumbers page.

type DescribeVerifiedDestinationNumbersPaginatorOptions 

type DescribeVerifiedDestinationNumbersPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeVerifiedDestinationNumbersPaginatorOptions is the paginator options for DescribeVerifiedDestinationNumbers

type DisassociateOriginationIdentityInput 

type DisassociateOriginationIdentityInput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// This member is required.
	IsoCountryCode *string

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbersfind the values for PhoneNumberId and
	// PhoneNumberArn, or use DescribeSenderIdsto get the values for SenderId and SenderIdArn.
	//
	// This member is required.
	OriginationIdentity *string

	// The unique identifier for the pool to disassociate with the origination
	// identity. This value can be either the PoolId or PoolArn.
	//
	// This member is required.
	PoolId *string

	// Unique, case-sensitive identifier you provide to ensure the idempotency of the
	// request. If you don't specify a client token, a randomly generated token is used
	// for the request to ensure idempotency.
	ClientToken *string
	// contains filtered or unexported fields
}

type DisassociateOriginationIdentityOutput 

type DisassociateOriginationIdentityOutput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	IsoCountryCode *string

	// The PhoneNumberId or SenderId of the origination identity.
	OriginationIdentity *string

	// The PhoneNumberArn or SenderIdArn of the origination identity.
	OriginationIdentityArn *string

	// The Amazon Resource Name (ARN) of the pool.
	PoolArn *string

	// The PoolId of the pool no longer associated with the origination identity.
	PoolId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateProtectConfigurationInput 

type DisassociateProtectConfigurationInput struct {

	// The name of the ConfigurationSet.
	//
	// This member is required.
	ConfigurationSetName *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string
	// contains filtered or unexported fields
}

type DisassociateProtectConfigurationOutput 

type DisassociateProtectConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration set.
	//
	// This member is required.
	ConfigurationSetArn *string

	// The name of the ConfigurationSet.
	//
	// This member is required.
	ConfigurationSetName *string

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DiscardRegistrationVersionInput 

type DiscardRegistrationVersionInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string
	// contains filtered or unexported fields
}

type DiscardRegistrationVersionOutput 

type DiscardRegistrationVersionOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The status of the registration version.
	//
	//   - DRAFT : The initial status of a registration version after it’s created.
	//
	//   - SUBMITTED : Your registration has been submitted.
	//
	//   - REVIEWING : Your registration has been accepted and is being reviewed.
	//
	//   - APPROVED : Your registration has been approved.
	//
	//   - DISCARDED : You've abandon this version of their registration to start over
	//   with a new version.
	//
	//   - DENIED : You must fix your registration and resubmit it.
	//
	//   - REVOKED : Your previously approved registration has been revoked.
	//
	//   - ARCHIVED : Your previously approved registration version moves into this
	//   status when a more recently submitted version is approved.
	//
	// This member is required.
	RegistrationVersionStatus types.RegistrationVersionStatus

	// The RegistrationVersionStatusHistory object contains the time stamps for when
	// the reservations status changes.
	//
	// This member is required.
	RegistrationVersionStatusHistory *types.RegistrationVersionStatusHistory

	// The version number of the registration.
	//
	// This member is required.
	VersionNumber *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetProtectConfigurationCountryRuleSetInput 

type GetProtectConfigurationCountryRuleSetInput struct {

	// The capability type to return the CountryRuleSet for. Valid values are SMS ,
	// VOICE , or MMS .
	//
	// This member is required.
	NumberCapability types.NumberCapability

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string
	// contains filtered or unexported fields
}

type GetProtectConfigurationCountryRuleSetOutput 

type GetProtectConfigurationCountryRuleSetOutput struct {

	// A map of ProtectConfigurationCountryRuleSetInformation objects that contain the
	// details for the requested NumberCapability. The Key is the two-letter ISO
	// country code. For a list of supported ISO country codes, see [Supported countries and regions (SMS channel)]in the Amazon
	// Pinpoint SMS user guide.
	//
	// [Supported countries and regions (SMS channel)]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html
	//
	// This member is required.
	CountryRuleSet map[string]types.ProtectConfigurationCountryRuleSetInformation

	// The capability type associated with the returned
	// ProtectConfigurationCountryRuleSetInformation objects.
	//
	// This member is required.
	NumberCapability types.NumberCapability

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListPoolOriginationIdentitiesAPIClient 

type ListPoolOriginationIdentitiesAPIClient interface {
	ListPoolOriginationIdentities(context.Context, *ListPoolOriginationIdentitiesInput, ...func(*Options)) (*ListPoolOriginationIdentitiesOutput, error)
}

ListPoolOriginationIdentitiesAPIClient is a client that implements the ListPoolOriginationIdentities operation.

type ListPoolOriginationIdentitiesInput 

type ListPoolOriginationIdentitiesInput struct {

	// The unique identifier for the pool. This value can be either the PoolId or
	// PoolArn.
	//
	// This member is required.
	PoolId *string

	// An array of PoolOriginationIdentitiesFilter objects to filter the results..
	Filters []types.PoolOriginationIdentitiesFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPoolOriginationIdentitiesOutput 

type ListPoolOriginationIdentitiesOutput struct {

	// The token to be used for the next set of paginated results. If this field is
	// empty then there are no more results.
	NextToken *string

	// An array of any OriginationIdentityMetadata objects.
	OriginationIdentities []types.OriginationIdentityMetadata

	// The Amazon Resource Name (ARN) for the pool.
	PoolArn *string

	// The unique PoolId of the pool.
	PoolId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPoolOriginationIdentitiesPaginator 

type ListPoolOriginationIdentitiesPaginator struct {
	// contains filtered or unexported fields
}

ListPoolOriginationIdentitiesPaginator is a paginator for ListPoolOriginationIdentities

func NewListPoolOriginationIdentitiesPaginator 

func NewListPoolOriginationIdentitiesPaginator(client ListPoolOriginationIdentitiesAPIClient, params *ListPoolOriginationIdentitiesInput, optFns ...func(*ListPoolOriginationIdentitiesPaginatorOptions)) *ListPoolOriginationIdentitiesPaginator

NewListPoolOriginationIdentitiesPaginator returns a new ListPoolOriginationIdentitiesPaginator

func (*ListPoolOriginationIdentitiesPaginator) HasMorePages 

func (p *ListPoolOriginationIdentitiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPoolOriginationIdentitiesPaginator) NextPage 

func (p *ListPoolOriginationIdentitiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPoolOriginationIdentitiesOutput, error)

NextPage retrieves the next ListPoolOriginationIdentities page.

type ListPoolOriginationIdentitiesPaginatorOptions 

type ListPoolOriginationIdentitiesPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPoolOriginationIdentitiesPaginatorOptions is the paginator options for ListPoolOriginationIdentities

type ListRegistrationAssociationsAPIClient 

type ListRegistrationAssociationsAPIClient interface {
	ListRegistrationAssociations(context.Context, *ListRegistrationAssociationsInput, ...func(*Options)) (*ListRegistrationAssociationsOutput, error)
}

ListRegistrationAssociationsAPIClient is a client that implements the ListRegistrationAssociations operation.

type ListRegistrationAssociationsInput 

type ListRegistrationAssociationsInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// An array of RegistrationAssociationFilter to apply to the results that are
	// returned.
	Filters []types.RegistrationAssociationFilter

	// The maximum number of results to return per each request.
	MaxResults *int32

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRegistrationAssociationsOutput 

type ListRegistrationAssociationsOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// An array of RegistrationAssociationMetadata objects.
	//
	// This member is required.
	RegistrationAssociations []types.RegistrationAssociationMetadata

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The type of registration form. The list of RegistrationTypes can be found using
	// the DescribeRegistrationTypeDefinitionsaction.
	//
	// This member is required.
	RegistrationType *string

	// The token to be used for the next set of paginated results. You don't need to
	// supply a value for this field in the initial request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRegistrationAssociationsPaginator 

type ListRegistrationAssociationsPaginator struct {
	// contains filtered or unexported fields
}

ListRegistrationAssociationsPaginator is a paginator for ListRegistrationAssociations

func NewListRegistrationAssociationsPaginator 

func NewListRegistrationAssociationsPaginator(client ListRegistrationAssociationsAPIClient, params *ListRegistrationAssociationsInput, optFns ...func(*ListRegistrationAssociationsPaginatorOptions)) *ListRegistrationAssociationsPaginator

NewListRegistrationAssociationsPaginator returns a new ListRegistrationAssociationsPaginator

func (*ListRegistrationAssociationsPaginator) HasMorePages 

func (p *ListRegistrationAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRegistrationAssociationsPaginator) NextPage 

func (p *ListRegistrationAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRegistrationAssociationsOutput, error)

NextPage retrieves the next ListRegistrationAssociations page.

type ListRegistrationAssociationsPaginatorOptions 

type ListRegistrationAssociationsPaginatorOptions struct {
	// The maximum number of results to return per each request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRegistrationAssociationsPaginatorOptions is the paginator options for ListRegistrationAssociations

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to query for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The ARN of the resource.
	ResourceArn *string

	// An array of key and value pair tags that are associated with the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutKeywordInput 

type PutKeywordInput struct {

	// The new keyword to add.
	//
	// This member is required.
	Keyword *string

	// The message associated with the keyword.
	//
	// This member is required.
	KeywordMessage *string

	// The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
	// SenderId or SenderIdArn. You can use DescribePhoneNumbersget the values for PhoneNumberId and
	// PhoneNumberArn while DescribeSenderIdscan be used to get the values for SenderId and SenderIdArn.
	//
	// This member is required.
	OriginationIdentity *string

	// The action to perform for the new keyword when it is received.
	//
	//   - AUTOMATIC_RESPONSE: A message is sent to the recipient.
	//
	//   - OPT_OUT: Keeps the recipient from receiving future messages.
	//
	//   - OPT_IN: The recipient wants to receive future messages.
	KeywordAction types.KeywordAction
	// contains filtered or unexported fields
}

type PutKeywordOutput 

type PutKeywordOutput struct {

	// The keyword that was added.
	Keyword *string

	// The action to perform when the keyword is used.
	KeywordAction types.KeywordAction

	// The message associated with the keyword.
	KeywordMessage *string

	// The PhoneNumberId or PoolId that the keyword was associated with.
	OriginationIdentity *string

	// The PhoneNumberArn or PoolArn that the keyword was associated with.
	OriginationIdentityArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutOptedOutNumberInput 

type PutOptedOutNumberInput struct {

	// The OptOutListName or OptOutListArn to add the phone number to.
	//
	// This member is required.
	OptOutListName *string

	// The phone number to add to the OptOutList in E.164 format.
	//
	// This member is required.
	OptedOutNumber *string
	// contains filtered or unexported fields
}

type PutOptedOutNumberOutput 

type PutOptedOutNumberOutput struct {

	// This is true if it was the end user who requested their phone number be
	// removed.
	EndUserOptedOut bool

	// The OptOutListArn that the phone number was removed from.
	OptOutListArn *string

	// The OptOutListName that the phone number was removed from.
	OptOutListName *string

	// The phone number that was added to the OptOutList.
	OptedOutNumber *string

	// The time that the phone number was added to the OptOutList, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	OptedOutTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutRegistrationFieldValueInput 

type PutRegistrationFieldValueInput struct {

	// The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
	//
	// This member is required.
	FieldPath *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The unique identifier for the registration attachment.
	RegistrationAttachmentId *string

	// An array of values for the form field.
	SelectChoices []string

	// The text data for a free form field.
	TextValue *string
	// contains filtered or unexported fields
}

type PutRegistrationFieldValueOutput 

type PutRegistrationFieldValueOutput struct {

	// The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
	//
	// This member is required.
	FieldPath *string

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The version number of the registration.
	//
	// This member is required.
	VersionNumber *int64

	// The unique identifier for the registration attachment.
	RegistrationAttachmentId *string

	// An array of values for the form field.
	SelectChoices []string

	// The text data for a free form field.
	TextValue *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ReleasePhoneNumberInput 

type ReleasePhoneNumberInput struct {

	// The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers
	// to get the values for PhoneNumberId and PhoneNumberArn.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type ReleasePhoneNumberOutput 

type ReleasePhoneNumberOutput struct {

	// The time when the phone number was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	IsoCountryCode *string

	// The message type that was associated with the phone number.
	MessageType types.MessageType

	// The monthly price of the phone number, in US dollars.
	MonthlyLeasingPrice *string

	// Specifies if the number could be used for text messages, voice, or both.
	NumberCapabilities []types.NumberCapability

	// The type of number that was released.
	NumberType types.NumberType

	// The name of the OptOutList that was associated with the phone number.
	OptOutListName *string

	// The phone number that was released.
	PhoneNumber *string

	// The PhoneNumberArn of the phone number that was released.
	PhoneNumberArn *string

	// The PhoneNumberId of the phone number that was released.
	PhoneNumberId *string

	// The unique identifier for the registration.
	RegistrationId *string

	// By default this is set to false. When an end recipient sends a message that
	// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
	// automatically replies with a customizable message and adds the end recipient to
	// the OptOutList. When set to true you're responsible for responding to HELP and
	// STOP requests. You're also responsible for tracking and honoring opt-out
	// requests.
	SelfManagedOptOutsEnabled bool

	// The current status of the request.
	Status types.NumberStatus

	// The Amazon Resource Name (ARN) of the TwoWayChannel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ReleaseSenderIdInput 

type ReleaseSenderIdInput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	//
	// This member is required.
	IsoCountryCode *string

	// The sender ID to release.
	//
	// This member is required.
	SenderId *string
	// contains filtered or unexported fields
}

type ReleaseSenderIdOutput 

type ReleaseSenderIdOutput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	//
	// This member is required.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	//
	// This member is required.
	MessageTypes []types.MessageType

	// The monthly price, in US dollars, to lease the sender ID.
	//
	// This member is required.
	MonthlyLeasingPrice *string

	// True if the sender ID is registered.
	//
	// This member is required.
	Registered bool

	// The sender ID that was released.
	//
	// This member is required.
	SenderId *string

	// The Amazon Resource Name (ARN) associated with the SenderId.
	//
	// This member is required.
	SenderIdArn *string

	// The unique identifier for the registration.
	RegistrationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RequestPhoneNumberInput 

type RequestPhoneNumberInput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	//
	// This member is required.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	//
	// This member is required.
	MessageType types.MessageType

	// Indicates if the phone number will be used for text messages, voice messages,
	// or both.
	//
	// This member is required.
	NumberCapabilities []types.NumberCapability

	// The type of phone number to request.
	//
	// This member is required.
	NumberType types.RequestableNumberType

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// By default this is set to false. When set to true the phone number can't be
	// deleted.
	DeletionProtectionEnabled *bool

	// The name of the OptOutList to associate with the phone number. You can use the
	// OptOutListName or OptOutListArn.
	OptOutListName *string

	// The pool to associated with the phone number. You can use the PoolId or
	// PoolArn.
	PoolId *string

	// Use this field to attach your phone number for an external registration process.
	RegistrationId *string

	// An array of tags (key and value pairs) associate with the requested phone
	// number.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type RequestPhoneNumberOutput 

type RequestPhoneNumberOutput struct {

	// The time when the phone number was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// By default this is set to false. When set to true the phone number can't be
	// deleted.
	DeletionProtectionEnabled bool

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	MessageType types.MessageType

	// The monthly price, in US dollars, to lease the phone number.
	MonthlyLeasingPrice *string

	// Indicates if the phone number will be used for text messages, voice messages or
	// both.
	NumberCapabilities []types.NumberCapability

	// The type of number that was released.
	NumberType types.RequestableNumberType

	// The name of the OptOutList that is associated with the requested phone number.
	OptOutListName *string

	// The new phone number that was requested.
	PhoneNumber *string

	// The Amazon Resource Name (ARN) of the requested phone number.
	PhoneNumberArn *string

	// The unique identifier of the new phone number.
	PhoneNumberId *string

	// The unique identifier of the pool associated with the phone number
	PoolId *string

	// The unique identifier for the registration.
	RegistrationId *string

	// By default this is set to false. When an end recipient sends a message that
	// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
	// automatically replies with a customizable message and adds the end recipient to
	// the OptOutList. When set to true you're responsible for responding to HELP and
	// STOP requests. You're also responsible for tracking and honoring opt-out
	// requests.
	SelfManagedOptOutsEnabled bool

	// The current status of the request.
	Status types.NumberStatus

	// An array of key and value pair tags that are associated with the phone number.
	Tags []types.Tag

	// The ARN used to identify the two way channel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RequestSenderIdInput 

type RequestSenderIdInput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	//
	// This member is required.
	IsoCountryCode *string

	// The sender ID string to request.
	//
	// This member is required.
	SenderId *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. If you don't specify a client token, a randomly generated token is
	// used for the request to ensure idempotency.
	ClientToken *string

	// By default this is set to false. When set to true the sender ID can't be
	// deleted.
	DeletionProtectionEnabled *bool

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	MessageTypes []types.MessageType

	// An array of tags (key and value pairs) to associate with the sender ID.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type RequestSenderIdOutput 

type RequestSenderIdOutput struct {

	// By default this is set to false. When set to true the sender ID can't be
	// deleted.
	//
	// This member is required.
	DeletionProtectionEnabled bool

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	//
	// This member is required.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	//
	// This member is required.
	MessageTypes []types.MessageType

	// The monthly price, in US dollars, to lease the sender ID.
	//
	// This member is required.
	MonthlyLeasingPrice *string

	// True if the sender ID is registered.
	//
	// This member is required.
	Registered bool

	// The sender ID that was requested.
	//
	// This member is required.
	SenderId *string

	// The Amazon Resource Name (ARN) associated with the SenderId.
	//
	// This member is required.
	SenderIdArn *string

	// An array of tags (key and value pairs) to associate with the sender ID.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SendDestinationNumberVerificationCodeInput 

type SendDestinationNumberVerificationCodeInput struct {

	// Choose to send the verification code as an SMS or voice message.
	//
	// This member is required.
	VerificationChannel types.VerificationChannel

	// The unique identifier for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberId *string

	// The name of the configuration set to use. This can be either the
	// ConfigurationSetName or ConfigurationSetArn.
	ConfigurationSetName *string

	// You can specify custom data in this field. If you do, that data is logged to
	// the event destination.
	Context map[string]string

	// This field is used for any country-specific registration requirements.
	// Currently, this setting is only used when you send messages to recipients in
	// India using a sender ID. For more information see [Special requirements for sending SMS messages to recipients in India].
	//
	// [Special requirements for sending SMS messages to recipients in India]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html
	DestinationCountryParameters map[string]string

	// Choose the language to use for the message.
	LanguageCode types.LanguageCode

	// The origination identity of the message. This can be either the PhoneNumber,
	// PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
	OriginationIdentity *string
	// contains filtered or unexported fields
}

type SendDestinationNumberVerificationCodeOutput 

type SendDestinationNumberVerificationCodeOutput struct {

	// The unique identifier for the message.
	//
	// This member is required.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SendMediaMessageInput 

type SendMediaMessageInput struct {

	// The destination phone number in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// The origination identity of the message. This can be either the PhoneNumber,
	// PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
	//
	// This member is required.
	OriginationIdentity *string

	// The name of the configuration set to use. This can be either the
	// ConfigurationSetName or ConfigurationSetArn.
	ConfigurationSetName *string

	// You can specify custom data in this field. If you do, that data is logged to
	// the event destination.
	Context map[string]string

	// When set to true, the message is checked and validated, but isn't sent to the
	// end recipient.
	DryRun bool

	// The maximum amount that you want to spend, in US dollars, per each MMS message.
	MaxPrice *string

	// An array of URLs to each media file to send.
	//
	// The media files have to be stored in a publicly available S3 bucket. Supported
	// media file formats are listed in [MMS file types, size and character limits]. For more information on creating an S3
	// bucket and managing objects, see [Creating a bucket]and [Uploading objects] in the S3 user guide.
	//
	// [Creating a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html
	// [MMS file types, size and character limits]: https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html
	// [Uploading objects]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html
	MediaUrls []string

	// The text body of the message.
	MessageBody *string

	// The unique identifier of the protect configuration to use.
	ProtectConfigurationId *string

	// How long the text message is valid for. By default this is 72 hours.
	TimeToLive *int32
	// contains filtered or unexported fields
}

type SendMediaMessageOutput 

type SendMediaMessageOutput struct {

	// The unique identifier for the message.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SendTextMessageInput 

type SendTextMessageInput struct {

	// The destination phone number in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// The name of the configuration set to use. This can be either the
	// ConfigurationSetName or ConfigurationSetArn.
	ConfigurationSetName *string

	// You can specify custom data in this field. If you do, that data is logged to
	// the event destination.
	Context map[string]string

	// This field is used for any country-specific registration requirements.
	// Currently, this setting is only used when you send messages to recipients in
	// India using a sender ID. For more information see [Special requirements for sending SMS messages to recipients in India].
	//
	// [Special requirements for sending SMS messages to recipients in India]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html
	DestinationCountryParameters map[string]string

	// When set to true, the message is checked and validated, but isn't sent to the
	// end recipient.
	DryRun bool

	// When you register a short code in the US, you must specify a program name. If
	// you don’t have a US short code, omit this attribute.
	Keyword *string

	// The maximum amount that you want to spend, in US dollars, per each text message
	// part. A text message can contain multiple parts.
	MaxPrice *string

	// The body of the text message.
	MessageBody *string

	// The type of message. Valid values are for messages that are critical or
	// time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	MessageType types.MessageType

	// The origination identity of the message. This can be either the PhoneNumber,
	// PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
	OriginationIdentity *string

	// The unique identifier for the protect configuration.
	ProtectConfigurationId *string

	// How long the text message is valid for. By default this is 72 hours.
	TimeToLive *int32
	// contains filtered or unexported fields
}

type SendTextMessageOutput 

type SendTextMessageOutput struct {

	// The unique identifier for the message.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SendVoiceMessageInput 

type SendVoiceMessageInput struct {

	// The destination phone number in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// The origination identity to use for the voice call. This can be the
	// PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
	//
	// This member is required.
	OriginationIdentity *string

	// The name of the configuration set to use. This can be either the
	// ConfigurationSetName or ConfigurationSetArn.
	ConfigurationSetName *string

	// You can specify custom data in this field. If you do, that data is logged to
	// the event destination.
	Context map[string]string

	// When set to true, the message is checked and validated, but isn't sent to the
	// end recipient.
	DryRun bool

	// The maximum amount to spend per voice message, in US dollars.
	MaxPricePerMinute *string

	// The text to convert to a voice message.
	MessageBody *string

	// Specifies if the MessageBody field contains text or [speech synthesis markup language (SSML)].
	//
	//   - TEXT: This is the default value. When used the maximum character limit is
	//   3000.
	//
	//   - SSML: When used the maximum character limit is 6000 including SSML tagging.
	//
	// [speech synthesis markup language (SSML)]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html
	MessageBodyTextType types.VoiceMessageBodyTextType

	// The unique identifier for the protect configuration.
	ProtectConfigurationId *string

	// How long the voice message is valid for. By default this is 72 hours.
	TimeToLive *int32

	// The voice for the [Amazon Polly] service to use. By default this is set to "MATTHEW".
	//
	// [Amazon Polly]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html
	VoiceId types.VoiceId
	// contains filtered or unexported fields
}

type SendVoiceMessageOutput 

type SendVoiceMessageOutput struct {

	// The unique identifier for the message.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetAccountDefaultProtectConfigurationInput 

type SetAccountDefaultProtectConfigurationInput struct {

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string
	// contains filtered or unexported fields
}

type SetAccountDefaultProtectConfigurationOutput 

type SetAccountDefaultProtectConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the account default protect configuration.
	//
	// This member is required.
	DefaultProtectConfigurationArn *string

	// The unique identifier of the account default protect configuration.
	//
	// This member is required.
	DefaultProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetDefaultMessageTypeInput 

type SetDefaultMessageTypeInput struct {

	// The configuration set to update with a new default message type. This field can
	// be the ConsigurationSetName or ConfigurationSetArn.
	//
	// This member is required.
	ConfigurationSetName *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	//
	// This member is required.
	MessageType types.MessageType
	// contains filtered or unexported fields
}

type SetDefaultMessageTypeOutput 

type SetDefaultMessageTypeOutput struct {

	// The Amazon Resource Name (ARN) of the updated configuration set.
	ConfigurationSetArn *string

	// The name of the configuration set that was updated.
	ConfigurationSetName *string

	// The new default message type of the configuration set.
	MessageType types.MessageType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetDefaultSenderIdInput 

type SetDefaultSenderIdInput struct {

	// The configuration set to updated with a new default SenderId. This field can be
	// the ConsigurationSetName or ConfigurationSetArn.
	//
	// This member is required.
	ConfigurationSetName *string

	// The current sender ID for the configuration set. When sending a text message to
	// a destination country which supports SenderIds, the default sender ID on the
	// configuration set specified on SendTextMessagewill be used if no dedicated origination phone
	// numbers or registered SenderIds are available in your account, instead of a
	// generic sender ID, such as 'NOTICE'.
	//
	// This member is required.
	SenderId *string
	// contains filtered or unexported fields
}

type SetDefaultSenderIdOutput 

type SetDefaultSenderIdOutput struct {

	// The Amazon Resource Name (ARN) of the updated configuration set.
	ConfigurationSetArn *string

	// The name of the configuration set that was updated.
	ConfigurationSetName *string

	// The default sender ID to set for the ConfigurationSet.
	SenderId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetMediaMessageSpendLimitOverrideInput 

type SetMediaMessageSpendLimitOverrideInput struct {

	// The new monthly limit to enforce on text messages.
	//
	// This member is required.
	MonthlyLimit *int64
	// contains filtered or unexported fields
}

type SetMediaMessageSpendLimitOverrideOutput 

type SetMediaMessageSpendLimitOverrideOutput struct {

	// The current monthly limit to enforce on sending text messages.
	MonthlyLimit *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetTextMessageSpendLimitOverrideInput 

type SetTextMessageSpendLimitOverrideInput struct {

	// The new monthly limit to enforce on text messages.
	//
	// This member is required.
	MonthlyLimit *int64
	// contains filtered or unexported fields
}

type SetTextMessageSpendLimitOverrideOutput 

type SetTextMessageSpendLimitOverrideOutput struct {

	// The current monthly limit to enforce on sending text messages.
	MonthlyLimit *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetVoiceMessageSpendLimitOverrideInput 

type SetVoiceMessageSpendLimitOverrideInput struct {

	// The new monthly limit to enforce on voice messages.
	//
	// This member is required.
	MonthlyLimit *int64
	// contains filtered or unexported fields
}

type SetVoiceMessageSpendLimitOverrideOutput 

type SetVoiceMessageSpendLimitOverrideOutput struct {

	// The current monthly limit to enforce on sending voice messages.
	MonthlyLimit *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SubmitRegistrationVersionInput 

type SubmitRegistrationVersionInput struct {

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string
	// contains filtered or unexported fields
}

type SubmitRegistrationVersionOutput 

type SubmitRegistrationVersionOutput struct {

	// The Amazon Resource Name (ARN) for the registration.
	//
	// This member is required.
	RegistrationArn *string

	// The unique identifier for the registration.
	//
	// This member is required.
	RegistrationId *string

	// The status of the registration version.
	//
	//   - DRAFT : The initial status of a registration version after it’s created.
	//
	//   - SUBMITTED : Your registration has been submitted.
	//
	//   - REVIEWING : Your registration has been accepted and is being reviewed.
	//
	//   - APPROVED : Your registration has been approved.
	//
	//   - DISCARDED : You've abandon this version of their registration to start over
	//   with a new version.
	//
	//   - DENIED : You must fix your registration and resubmit it.
	//
	//   - REVOKED : Your previously approved registration has been revoked.
	//
	//   - ARCHIVED : Your previously approved registration version moves into this
	//   status when a more recently submitted version is approved.
	//
	// This member is required.
	RegistrationVersionStatus types.RegistrationVersionStatus

	// The RegistrationVersionStatusHistory object contains the time stamps for when
	// the reservations status changes.
	//
	// This member is required.
	RegistrationVersionStatusHistory *types.RegistrationVersionStatusHistory

	// The version number of the registration.
	//
	// This member is required.
	VersionNumber *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// An array of key and value pair tags that are associated with the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// An array of tag key values to unassociate with the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEventDestinationInput 

type UpdateEventDestinationInput struct {

	// The configuration set to update with the new event destination. Valid values
	// for this can be the ConfigurationSetName or ConfigurationSetArn.
	//
	// This member is required.
	ConfigurationSetName *string

	// The name to use for the event destination.
	//
	// This member is required.
	EventDestinationName *string

	// An object that contains information about an event destination that sends data
	// to CloudWatch Logs.
	CloudWatchLogsDestination *types.CloudWatchLogsDestination

	// When set to true logging is enabled.
	Enabled *bool

	// An object that contains information about an event destination for logging to
	// Kinesis Data Firehose.
	KinesisFirehoseDestination *types.KinesisFirehoseDestination

	// An array of event types that determine which events to log.
	//
	// The TEXT_SENT event type is not supported.
	MatchingEventTypes []types.EventType

	// An object that contains information about an event destination that sends data
	// to Amazon SNS.
	SnsDestination *types.SnsDestination
	// contains filtered or unexported fields
}

type UpdateEventDestinationOutput 

type UpdateEventDestinationOutput struct {

	// The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
	ConfigurationSetArn *string

	// The name of the configuration set.
	ConfigurationSetName *string

	// An EventDestination object containing the details of where events will be
	// logged.
	EventDestination *types.EventDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePhoneNumberInput 

type UpdatePhoneNumberInput struct {

	// The unique identifier of the phone number. Valid values for this field can be
	// either the PhoneNumberId or PhoneNumberArn.
	//
	// This member is required.
	PhoneNumberId *string

	// By default this is set to false. When set to true the phone number can't be
	// deleted.
	DeletionProtectionEnabled *bool

	// The OptOutList to add the phone number to. Valid values for this field can be
	// either the OutOutListName or OutOutListArn.
	OptOutListName *string

	// By default this is set to false. When an end recipient sends a message that
	// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
	// automatically replies with a customizable message and adds the end recipient to
	// the OptOutList. When set to true you're responsible for responding to HELP and
	// STOP requests. You're also responsible for tracking and honoring opt-out
	// requests.
	SelfManagedOptOutsEnabled *bool

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled *bool
	// contains filtered or unexported fields
}

type UpdatePhoneNumberOutput 

type UpdatePhoneNumberOutput struct {

	// The time when the phone number was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// When set to true the phone number can't be deleted.
	DeletionProtectionEnabled bool

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	MessageType types.MessageType

	// The monthly leasing price of the phone number, in US dollars.
	MonthlyLeasingPrice *string

	// Specifies if the number could be used for text messages, voice or both.
	NumberCapabilities []types.NumberCapability

	// The type of number that was requested.
	NumberType types.NumberType

	// The name of the OptOutList associated with the phone number.
	OptOutListName *string

	// The phone number that was updated.
	PhoneNumber *string

	// The Amazon Resource Name (ARN) of the updated phone number.
	PhoneNumberArn *string

	// The unique identifier of the phone number.
	PhoneNumberId *string

	// The unique identifier for the registration.
	RegistrationId *string

	// This is true if self managed opt-out are enabled.
	SelfManagedOptOutsEnabled bool

	// The current status of the request.
	Status types.NumberStatus

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePoolInput 

type UpdatePoolInput struct {

	// The unique identifier of the pool to update. Valid values are either the PoolId
	// or PoolArn.
	//
	// This member is required.
	PoolId *string

	// When set to true the pool can't be deleted.
	DeletionProtectionEnabled *bool

	// The OptOutList to associate with the pool. Valid values are either
	// OptOutListName or OptOutListArn.
	OptOutListName *string

	// By default this is set to false. When an end recipient sends a message that
	// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
	// automatically replies with a customizable message and adds the end recipient to
	// the OptOutList. When set to true you're responsible for responding to HELP and
	// STOP requests. You're also responsible for tracking and honoring opt-out
	// requests.
	SelfManagedOptOutsEnabled *bool

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled *bool

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled *bool
	// contains filtered or unexported fields
}

type UpdatePoolOutput 

type UpdatePoolOutput struct {

	// The time when the pool was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	CreatedTimestamp *time.Time

	// When set to true the pool can't be deleted.
	DeletionProtectionEnabled bool

	// The type of message for the pool to use.
	MessageType types.MessageType

	// The name of the OptOutList associated with the pool.
	OptOutListName *string

	// The ARN of the pool.
	PoolArn *string

	// The unique identifier of the pool.
	PoolId *string

	// When an end recipient sends a message that begins with HELP or STOP to one of
	// your dedicated numbers, Amazon Pinpoint automatically replies with a
	// customizable message and adds the end recipient to the OptOutList. When set to
	// true you're responsible for responding to HELP and STOP requests. You're also
	// responsible for tracking and honoring opt-out requests.
	SelfManagedOptOutsEnabled bool

	// Indicates whether shared routes are enabled for the pool.
	SharedRoutesEnabled bool

	// The current status of the pool update request.
	Status types.PoolStatus

	// The Amazon Resource Name (ARN) of the two way channel.
	TwoWayChannelArn *string

	// An optional IAM Role Arn for a service to assume, to be able to post inbound
	// SMS messages.
	TwoWayChannelRole *string

	// By default this is set to false. When set to true you can receive incoming text
	// messages from your end recipients.
	TwoWayEnabled bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateProtectConfigurationCountryRuleSetInput 

type UpdateProtectConfigurationCountryRuleSetInput struct {

	// A map of ProtectConfigurationCountryRuleSetInformation objects that contain the
	// details for the requested NumberCapability. The Key is the two-letter ISO
	// country code. For a list of supported ISO country codes, see [Supported countries and regions (SMS channel)]in the Amazon
	// Pinpoint SMS user guide.
	//
	// [Supported countries and regions (SMS channel)]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html
	//
	// This member is required.
	CountryRuleSetUpdates map[string]types.ProtectConfigurationCountryRuleSetInformation

	// The number capability to apply the CountryRuleSetUpdates updates to.
	//
	// This member is required.
	NumberCapability types.NumberCapability

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string
	// contains filtered or unexported fields
}

type UpdateProtectConfigurationCountryRuleSetOutput 

type UpdateProtectConfigurationCountryRuleSetOutput struct {

	// An array of ProtectConfigurationCountryRuleSetInformation containing the rules
	// for the NumberCapability.
	//
	// This member is required.
	CountryRuleSet map[string]types.ProtectConfigurationCountryRuleSetInformation

	// The number capability that was updated
	//
	// This member is required.
	NumberCapability types.NumberCapability

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateProtectConfigurationInput 

type UpdateProtectConfigurationInput struct {

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// When set to true deletion protection is enabled. By default this is set to
	// false.
	DeletionProtectionEnabled *bool
	// contains filtered or unexported fields
}

type UpdateProtectConfigurationOutput 

type UpdateProtectConfigurationOutput struct {

	// This is true if the protect configuration is set as your account default
	// protect configuration.
	//
	// This member is required.
	AccountDefault bool

	// The time when the protect configuration was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The status of deletion protection for the protect configuration. When set to
	// true deletion protection is enabled. By default this is set to false.
	//
	// This member is required.
	DeletionProtectionEnabled bool

	// The Amazon Resource Name (ARN) of the protect configuration.
	//
	// This member is required.
	ProtectConfigurationArn *string

	// The unique identifier for the protect configuration.
	//
	// This member is required.
	ProtectConfigurationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSenderIdInput 

type UpdateSenderIdInput struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	//
	// This member is required.
	IsoCountryCode *string

	// The sender ID to update.
	//
	// This member is required.
	SenderId *string

	// By default this is set to false. When set to true the sender ID can't be
	// deleted.
	DeletionProtectionEnabled *bool
	// contains filtered or unexported fields
}

type UpdateSenderIdOutput 

type UpdateSenderIdOutput struct {

	// By default this is set to false. When set to true the sender ID can't be
	// deleted.
	//
	// This member is required.
	DeletionProtectionEnabled bool

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
	//
	// This member is required.
	IsoCountryCode *string

	// The type of message. Valid values are TRANSACTIONAL for messages that are
	// critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
	// time-sensitive.
	//
	// This member is required.
	MessageTypes []types.MessageType

	// The monthly price, in US dollars, to lease the sender ID.
	//
	// This member is required.
	MonthlyLeasingPrice *string

	// True if the sender ID is registered..
	//
	// This member is required.
	Registered bool

	// The sender ID that was updated.
	//
	// This member is required.
	SenderId *string

	// The Amazon Resource Name (ARN) associated with the SenderId.
	//
	// This member is required.
	SenderIdArn *string

	// The unique identifier for the registration.
	RegistrationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type VerifyDestinationNumberInput 

type VerifyDestinationNumberInput struct {

	// The verification code that was received by the verified destination phone
	// number.
	//
	// This member is required.
	VerificationCode *string

	// The unique identifier for the verififed destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberId *string
	// contains filtered or unexported fields
}

type VerifyDestinationNumberOutput 

type VerifyDestinationNumberOutput struct {

	// The time when the destination phone number was created, in [UNIX epoch time] format.
	//
	// [UNIX epoch time]: https://www.epochconverter.com/
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The phone number in E.164 format.
	//
	// This member is required.
	DestinationPhoneNumber *string

	// The status for being able to send messages to the phone number.
	//
	// This member is required.
	Status types.VerificationStatus

	// The Amazon Resource Name (ARN) for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberArn *string

	// The unique identifier for the verified destination phone number.
	//
	// This member is required.
	VerifiedDestinationNumberId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.