socialmessaging

package module
v1.1.5 Latest Latest
Warning

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

 Go to latest Published: Jan 24, 2025 License: Apache-2.0 Imports: 42 Imported by: 2

Documentation

Overview

Package socialmessaging provides the API client, operations, and parameter types for AWS End User Messaging Social. 

Amazon Web Services End User Messaging Social, also referred to as Social

messaging, is a messaging service that enables application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.

The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.

If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is Amazon Web Services End User Messaging Socialin the Amazon Web Services End User Messaging Social User Guide. The Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications. The guide also provides key information, such as integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated 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 Web Services End User Messaging 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 = "2024-01-01"
View Source 
const ServiceID = "SocialMessaging"

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 AssociateWhatsAppBusinessAccountInput 

type AssociateWhatsAppBusinessAccountInput struct {

	// A JSON object that contains the phone numbers and WhatsApp Business Account to
	// link to your account.
	SetupFinalization *types.WhatsAppSetupFinalization

	// Contains the callback access token.
	SignupCallback *types.WhatsAppSignupCallback
	// contains filtered or unexported fields
}

type AssociateWhatsAppBusinessAccountOutput 

type AssociateWhatsAppBusinessAccountOutput struct {

	// Contains your WhatsApp registration status.
	SignupCallbackResult *types.WhatsAppSignupCallbackResult

	// The status code for the response.
	StatusCode *int32

	// 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 AWS End User Messaging Social.

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) AssociateWhatsAppBusinessAccount 

func (c *Client) AssociateWhatsAppBusinessAccount(ctx context.Context, params *AssociateWhatsAppBusinessAccountInput, optFns ...func(*Options)) (*AssociateWhatsAppBusinessAccountOutput, error)

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

func (*Client) DeleteWhatsAppMessageMedia 

func (c *Client) DeleteWhatsAppMessageMedia(ctx context.Context, params *DeleteWhatsAppMessageMediaInput, optFns ...func(*Options)) (*DeleteWhatsAppMessageMediaOutput, error)

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

func (*Client) DisassociateWhatsAppBusinessAccount 

func (c *Client) DisassociateWhatsAppBusinessAccount(ctx context.Context, params *DisassociateWhatsAppBusinessAccountInput, optFns ...func(*Options)) (*DisassociateWhatsAppBusinessAccountOutput, error)

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

func (*Client) GetLinkedWhatsAppBusinessAccount 

func (c *Client) GetLinkedWhatsAppBusinessAccount(ctx context.Context, params *GetLinkedWhatsAppBusinessAccountInput, optFns ...func(*Options)) (*GetLinkedWhatsAppBusinessAccountOutput, error)

Get the details of your linked WhatsApp Business Account.

func (*Client) GetLinkedWhatsAppBusinessAccountPhoneNumber 

func (c *Client) GetLinkedWhatsAppBusinessAccountPhoneNumber(ctx context.Context, params *GetLinkedWhatsAppBusinessAccountPhoneNumberInput, optFns ...func(*Options)) (*GetLinkedWhatsAppBusinessAccountPhoneNumberOutput, error)

Use your WhatsApp phone number id to get the WABA account id and phone number details.

func (*Client) GetWhatsAppMessageMedia 

func (c *Client) GetWhatsAppMessageMedia(ctx context.Context, params *GetWhatsAppMessageMediaInput, optFns ...func(*Options)) (*GetWhatsAppMessageMediaOutput, error)

Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.

func (*Client) ListLinkedWhatsAppBusinessAccounts 

func (c *Client) ListLinkedWhatsAppBusinessAccounts(ctx context.Context, params *ListLinkedWhatsAppBusinessAccountsInput, optFns ...func(*Options)) (*ListLinkedWhatsAppBusinessAccountsOutput, error)

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

func (*Client) ListTagsForResource 

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

List all tags associated with a resource, such as a phone number or WABA.

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) PostWhatsAppMessageMedia 

func (c *Client) PostWhatsAppMessageMedia(ctx context.Context, params *PostWhatsAppMessageMediaInput, optFns ...func(*Options)) (*PostWhatsAppMessageMediaOutput, error)

Upload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage . You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.

func (*Client) PutWhatsAppBusinessAccountEventDestinations 

func (c *Client) PutWhatsAppBusinessAccountEventDestinations(ctx context.Context, params *PutWhatsAppBusinessAccountEventDestinationsInput, optFns ...func(*Options)) (*PutWhatsAppBusinessAccountEventDestinationsOutput, error)

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.

func (*Client) SendWhatsAppMessage 

func (c *Client) SendWhatsAppMessage(ctx context.Context, params *SendWhatsAppMessageInput, optFns ...func(*Options)) (*SendWhatsAppMessageOutput, error)

Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messagesin the Amazon Web Services End User Messaging Social User Guide .

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 resource. When you specify an existing tag key, the value is overwritten with the new value.

func (*Client) UntagResource 

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

Removes the specified tags from a resource.

type DeleteWhatsAppMessageMediaInput 

type DeleteWhatsAppMessageMediaInput struct {

	// The unique identifier of the media file to delete. Use the mediaId returned
	// from [PostWhatsAppMessageMedia].
	//
	// [PostWhatsAppMessageMedia]: https://console.aws.amazon.com/social-messaging/latest/APIReference/API_PostWhatsAppMessageMedia.html
	//
	// This member is required.
	MediaId *string

	// The unique identifier of the originating phone number associated with the
	// media. Phone number identifiers are formatted as
	// phone-number-id-01234567890123456789012345678901 . Use [GetLinkedWhatsAppBusinessAccount] to find a phone
	// number's id.
	//
	// [GetLinkedWhatsAppBusinessAccount]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html
	//
	// This member is required.
	OriginationPhoneNumberId *string
	// contains filtered or unexported fields
}

type DeleteWhatsAppMessageMediaOutput 

type DeleteWhatsAppMessageMediaOutput struct {

	// Success indicator for deleting the media file.
	Success *bool

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

type DisassociateWhatsAppBusinessAccountInput 

type DisassociateWhatsAppBusinessAccountInput struct {

	// The unique identifier of your WhatsApp Business Account. WABA identifiers are
	// formatted as waba-01234567890123456789012345678901 . Use [ListLinkedWhatsAppBusinessAccounts] to list all WABAs and
	// their details.
	//
	// [ListLinkedWhatsAppBusinessAccounts]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DisassociateWhatsAppBusinessAccountOutput 

type DisassociateWhatsAppBusinessAccountOutput struct {
	// 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 GetLinkedWhatsAppBusinessAccountInput 

type GetLinkedWhatsAppBusinessAccountInput struct {

	// The unique identifier, from Amazon Web Services, of the linked WhatsApp
	// Business Account. WABA identifiers are formatted as
	// waba-01234567890123456789012345678901 . Use [ListLinkedWhatsAppBusinessAccounts] to list all WABAs and their
	// details.
	//
	// [ListLinkedWhatsAppBusinessAccounts]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetLinkedWhatsAppBusinessAccountOutput 

type GetLinkedWhatsAppBusinessAccountOutput struct {

	// The details of the linked WhatsApp Business Account.
	Account *types.LinkedWhatsAppBusinessAccount

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

type GetLinkedWhatsAppBusinessAccountPhoneNumberInput 

type GetLinkedWhatsAppBusinessAccountPhoneNumberInput struct {

	// The unique identifier of the phone number. Phone number identifiers are
	// formatted as phone-number-id-01234567890123456789012345678901 . Use [GetLinkedWhatsAppBusinessAccount] to find a
	// phone number's id.
	//
	// [GetLinkedWhatsAppBusinessAccount]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetLinkedWhatsAppBusinessAccountPhoneNumberOutput 

type GetLinkedWhatsAppBusinessAccountPhoneNumberOutput struct {

	// The WABA identifier linked to the phone number, formatted as
	// waba-01234567890123456789012345678901 .
	LinkedWhatsAppBusinessAccountId *string

	// The details of your WhatsApp phone number.
	PhoneNumber *types.WhatsAppPhoneNumberDetail

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

type GetWhatsAppMessageMediaInput 

type GetWhatsAppMessageMediaInput struct {

	// The unique identifier for the media file.
	//
	// This member is required.
	MediaId *string

	// The unique identifier of the originating phone number for the WhatsApp message
	// media. The phone number identifiers are formatted as
	// phone-number-id-01234567890123456789012345678901 . Use [GetLinkedWhatsAppBusinessAccount] to find a phone
	// number's id.
	//
	// [GetLinkedWhatsAppBusinessAccount]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html
	//
	// This member is required.
	OriginationPhoneNumberId *string

	// The bucketName and key of the S3 media file.
	DestinationS3File *types.S3File

	// The presign url of the media file.
	DestinationS3PresignedUrl *types.S3PresignedUrl

	// Set to True to get only the metadata for the file.
	MetadataOnly *bool
	// contains filtered or unexported fields
}

type GetWhatsAppMessageMediaOutput 

type GetWhatsAppMessageMediaOutput struct {

	// The file size of the media, in KB.
	FileSize *int64

	// The MIME type of the media.
	MimeType *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 ListLinkedWhatsAppBusinessAccountsAPIClient 

type ListLinkedWhatsAppBusinessAccountsAPIClient interface {
	ListLinkedWhatsAppBusinessAccounts(context.Context, *ListLinkedWhatsAppBusinessAccountsInput, ...func(*Options)) (*ListLinkedWhatsAppBusinessAccountsOutput, error)
}

ListLinkedWhatsAppBusinessAccountsAPIClient is a client that implements the ListLinkedWhatsAppBusinessAccounts operation.

type ListLinkedWhatsAppBusinessAccountsInput 

type ListLinkedWhatsAppBusinessAccountsInput struct {

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

	// The next token for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLinkedWhatsAppBusinessAccountsOutput 

type ListLinkedWhatsAppBusinessAccountsOutput struct {

	// A list of WhatsApp Business Accounts linked to your Amazon Web Services account.
	LinkedAccounts []types.LinkedWhatsAppBusinessAccountSummary

	// The next token for pagination.
	NextToken *string

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

type ListLinkedWhatsAppBusinessAccountsPaginator 

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

ListLinkedWhatsAppBusinessAccountsPaginator is a paginator for ListLinkedWhatsAppBusinessAccounts

func NewListLinkedWhatsAppBusinessAccountsPaginator 

func NewListLinkedWhatsAppBusinessAccountsPaginator(client ListLinkedWhatsAppBusinessAccountsAPIClient, params *ListLinkedWhatsAppBusinessAccountsInput, optFns ...func(*ListLinkedWhatsAppBusinessAccountsPaginatorOptions)) *ListLinkedWhatsAppBusinessAccountsPaginator

NewListLinkedWhatsAppBusinessAccountsPaginator returns a new ListLinkedWhatsAppBusinessAccountsPaginator

func (*ListLinkedWhatsAppBusinessAccountsPaginator) HasMorePages 

func (p *ListLinkedWhatsAppBusinessAccountsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLinkedWhatsAppBusinessAccountsPaginator) NextPage 

func (p *ListLinkedWhatsAppBusinessAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLinkedWhatsAppBusinessAccountsOutput, error)

NextPage retrieves the next ListLinkedWhatsAppBusinessAccounts page.

type ListLinkedWhatsAppBusinessAccountsPaginatorOptions 

type ListLinkedWhatsAppBusinessAccountsPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListLinkedWhatsAppBusinessAccountsPaginatorOptions is the paginator options for ListLinkedWhatsAppBusinessAccounts

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The status code of the response.
	StatusCode *int32

	// The tags for 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

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

	// 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 PostWhatsAppMessageMediaInput 

type PostWhatsAppMessageMediaInput struct {

	// The ID of the phone number to associate with the WhatsApp media file. The phone
	// number identifiers are formatted as
	// phone-number-id-01234567890123456789012345678901 . Use [GetLinkedWhatsAppBusinessAccount] to find a phone
	// number's id.
	//
	// [GetLinkedWhatsAppBusinessAccount]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html
	//
	// This member is required.
	OriginationPhoneNumberId *string

	// The source S3 url for the media file.
	SourceS3File *types.S3File

	// The source presign url of the media file.
	SourceS3PresignedUrl *types.S3PresignedUrl
	// contains filtered or unexported fields
}

type PostWhatsAppMessageMediaOutput 

type PostWhatsAppMessageMediaOutput struct {

	// The unique identifier of the posted WhatsApp message.
	MediaId *string

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

type PutWhatsAppBusinessAccountEventDestinationsInput 

type PutWhatsAppBusinessAccountEventDestinationsInput struct {

	// An array of WhatsAppBusinessAccountEventDestination event destinations.
	//
	// This member is required.
	EventDestinations []types.WhatsAppBusinessAccountEventDestination

	// The unique identifier of your WhatsApp Business Account. WABA identifiers are
	// formatted as waba-01234567890123456789012345678901 . Use [ListLinkedWhatsAppBusinessAccounts] to list all WABAs and
	// their details.
	//
	// [ListLinkedWhatsAppBusinessAccounts]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type PutWhatsAppBusinessAccountEventDestinationsOutput 

type PutWhatsAppBusinessAccountEventDestinationsOutput struct {
	// 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 SendWhatsAppMessageInput 

type SendWhatsAppMessageInput struct {

	// The message to send through WhatsApp. The length is in KB. The message field
	// passes through a WhatsApp Message object, see [Messages]in the WhatsApp Business Platform
	// Cloud API Reference.
	//
	// [Messages]: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages
	//
	// This member is required.
	Message []byte

	// The API version for the request formatted as v{VersionNumber} . For a list of
	// supported API versions and Amazon Web Services Regions, see [Amazon Web Services End User Messaging Social API Service Endpoints]in the Amazon Web
	// Services General Reference.
	//
	// [Amazon Web Services End User Messaging Social API Service Endpoints]: https://docs.aws.amazon.com/general/latest/gr/end-user-messaging.html
	//
	// This member is required.
	MetaApiVersion *string

	// The ID of the phone number used to send the WhatsApp message. If you are
	// sending a media file only the originationPhoneNumberId used to upload the file
	// can be used. Phone number identifiers are formatted as
	// phone-number-id-01234567890123456789012345678901 . Use [GetLinkedWhatsAppBusinessAccount] to find a phone
	// number's id.
	//
	// [GetLinkedWhatsAppBusinessAccount]: https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html
	//
	// This member is required.
	OriginationPhoneNumberId *string
	// contains filtered or unexported fields
}

type SendWhatsAppMessageOutput 

type SendWhatsAppMessageOutput struct {

	// The unique identifier of the message.
	MessageId *string

	// 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 to tag.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {

	// The status code of the tag resource operation.
	StatusCode *int32

	// 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 to remove tags from.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {

	// The status code of the untag resource operation.
	StatusCode *int32

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