chimesdkvoice

package module
v1.14.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 40 Imported by: 2

Documentation

Overview

Package chimesdkvoice provides the API client, operations, and parameter types for Amazon Chime SDK Voice.

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

Index

Constants

View Source 
const ServiceAPIVersion = "2022-08-03"
View Source 
const ServiceID = "Chime SDK Voice"

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 added in v1.7.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.11.3 

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 added in v1.11.3 

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 AssociatePhoneNumbersWithVoiceConnectorGroupInput 

type AssociatePhoneNumbersWithVoiceConnectorGroupInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Amazon Chime SDK Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string

	// If true, associates the provided phone numbers with the provided Amazon Chime
	// SDK Voice Connector Group and removes any previously existing associations. If
	// false, does not associate any phone numbers that have previously existing
	// associations.
	ForceAssociate *bool
	// contains filtered or unexported fields
}

type AssociatePhoneNumbersWithVoiceConnectorGroupOutput 

type AssociatePhoneNumbersWithVoiceConnectorGroupOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

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

type AssociatePhoneNumbersWithVoiceConnectorInput 

type AssociatePhoneNumbersWithVoiceConnectorInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// If true, associates the provided phone numbers with the provided Amazon Chime
	// SDK Voice Connector and removes any previously existing associations. If false,
	// does not associate any phone numbers that have previously existing associations.
	ForceAssociate *bool
	// contains filtered or unexported fields
}

type AssociatePhoneNumbersWithVoiceConnectorOutput 

type AssociatePhoneNumbersWithVoiceConnectorOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

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

type AuthResolverParameters added in v1.11.3 

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 added in v1.11.3 

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

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

type BatchDeletePhoneNumberInput 

type BatchDeletePhoneNumberInput struct {

	// List of phone number IDs.
	//
	// This member is required.
	PhoneNumberIds []string
	// contains filtered or unexported fields
}

type BatchDeletePhoneNumberOutput 

type BatchDeletePhoneNumberOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

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

type BatchUpdatePhoneNumberInput 

type BatchUpdatePhoneNumberInput struct {

	// Lists the phone numbers in the update request.
	//
	// This member is required.
	UpdatePhoneNumberRequestItems []types.UpdatePhoneNumberRequestItem
	// contains filtered or unexported fields
}

type BatchUpdatePhoneNumberOutput 

type BatchUpdatePhoneNumberOutput struct {

	// A list of failed phone numbers and their error messages.
	PhoneNumberErrors []types.PhoneNumberError

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

type Client 

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

Client provides the API client to make operations call for Amazon Chime SDK Voice.

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

func (c *Client) AssociatePhoneNumbersWithVoiceConnector(ctx context.Context, params *AssociatePhoneNumbersWithVoiceConnectorInput, optFns ...func(*Options)) (*AssociatePhoneNumbersWithVoiceConnectorOutput, error)

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

func (*Client) AssociatePhoneNumbersWithVoiceConnectorGroup 

func (c *Client) AssociatePhoneNumbersWithVoiceConnectorGroup(ctx context.Context, params *AssociatePhoneNumbersWithVoiceConnectorGroupInput, optFns ...func(*Options)) (*AssociatePhoneNumbersWithVoiceConnectorGroupOutput, error)

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

func (*Client) BatchDeletePhoneNumber 

func (c *Client) BatchDeletePhoneNumber(ctx context.Context, params *BatchDeletePhoneNumberInput, optFns ...func(*Options)) (*BatchDeletePhoneNumberOutput, error)

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

func (*Client) BatchUpdatePhoneNumber 

func (c *Client) BatchUpdatePhoneNumber(ctx context.Context, params *BatchUpdatePhoneNumberInput, optFns ...func(*Options)) (*BatchUpdatePhoneNumberOutput, error)

Updates one or more phone numbers.

func (*Client) CreatePhoneNumberOrder 

func (c *Client) CreatePhoneNumberOrder(ctx context.Context, params *CreatePhoneNumberOrderInput, optFns ...func(*Options)) (*CreatePhoneNumberOrderOutput, error)

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

func (*Client) CreateProxySession 

func (c *Client) CreateProxySession(ctx context.Context, params *CreateProxySessionInput, optFns ...func(*Options)) (*CreateProxySessionOutput, error)

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

func (*Client) CreateSipMediaApplication 

func (c *Client) CreateSipMediaApplication(ctx context.Context, params *CreateSipMediaApplicationInput, optFns ...func(*Options)) (*CreateSipMediaApplicationOutput, error)

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) in the Amazon Chime SDK Administrator Guide.

func (*Client) CreateSipMediaApplicationCall 

func (c *Client) CreateSipMediaApplicationCall(ctx context.Context, params *CreateSipMediaApplicationCallInput, optFns ...func(*Options)) (*CreateSipMediaApplicationCallOutput, error)

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId .

func (*Client) CreateSipRule 

func (c *Client) CreateSipRule(ctx context.Context, params *CreateSipRuleInput, optFns ...func(*Options)) (*CreateSipRuleOutput, error)

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) in the Amazon Chime SDK Administrator Guide.

func (*Client) CreateVoiceConnector 

func (c *Client) CreateVoiceConnector(ctx context.Context, params *CreateVoiceConnectorInput, optFns ...func(*Options)) (*CreateVoiceConnectorOutput, error)

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups (https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html) in the Amazon Chime SDK Administrator Guide.

func (*Client) CreateVoiceConnectorGroup 

func (c *Client) CreateVoiceConnectorGroup(ctx context.Context, params *CreateVoiceConnectorGroupInput, optFns ...func(*Options)) (*CreateVoiceConnectorGroupOutput, error)

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request. You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

func (*Client) CreateVoiceProfile added in v1.3.0 

func (c *Client) CreateVoiceProfile(ctx context.Context, params *CreateVoiceProfileInput, optFns ...func(*Options)) (*CreateVoiceProfileOutput, error)

Creates a voice profile, which consists of an enrolled user and their latest voice print. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK. For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in the Amazon Chime SDK Developer Guide.

func (*Client) CreateVoiceProfileDomain added in v1.3.0 

func (c *Client) CreateVoiceProfileDomain(ctx context.Context, params *CreateVoiceProfileDomainInput, optFns ...func(*Options)) (*CreateVoiceProfileDomainOutput, error)

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK. For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in the Amazon Chime SDK Developer Guide.

func (*Client) DeletePhoneNumber 

func (c *Client) DeletePhoneNumber(ctx context.Context, params *DeletePhoneNumberInput, optFns ...func(*Options)) (*DeletePhoneNumberOutput, error)

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.

func (*Client) DeleteProxySession 

func (c *Client) DeleteProxySession(ctx context.Context, params *DeleteProxySessionInput, optFns ...func(*Options)) (*DeleteProxySessionOutput, error)

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

func (*Client) DeleteSipMediaApplication 

func (c *Client) DeleteSipMediaApplication(ctx context.Context, params *DeleteSipMediaApplicationInput, optFns ...func(*Options)) (*DeleteSipMediaApplicationOutput, error)

Deletes a SIP media application.

func (*Client) DeleteSipRule 

func (c *Client) DeleteSipRule(ctx context.Context, params *DeleteSipRuleInput, optFns ...func(*Options)) (*DeleteSipRuleOutput, error)

Deletes a SIP rule.

func (*Client) DeleteVoiceConnector 

func (c *Client) DeleteVoiceConnector(ctx context.Context, params *DeleteVoiceConnectorInput, optFns ...func(*Options)) (*DeleteVoiceConnectorOutput, error)

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

func (*Client) DeleteVoiceConnectorEmergencyCallingConfiguration 

func (c *Client) DeleteVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *DeleteVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorEmergencyCallingConfigurationOutput, error)

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

func (*Client) DeleteVoiceConnectorGroup 

func (c *Client) DeleteVoiceConnectorGroup(ctx context.Context, params *DeleteVoiceConnectorGroupInput, optFns ...func(*Options)) (*DeleteVoiceConnectorGroupOutput, error)

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

func (*Client) DeleteVoiceConnectorOrigination 

func (c *Client) DeleteVoiceConnectorOrigination(ctx context.Context, params *DeleteVoiceConnectorOriginationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorOriginationOutput, error)

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

func (*Client) DeleteVoiceConnectorProxy 

func (c *Client) DeleteVoiceConnectorProxy(ctx context.Context, params *DeleteVoiceConnectorProxyInput, optFns ...func(*Options)) (*DeleteVoiceConnectorProxyOutput, error)

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

func (*Client) DeleteVoiceConnectorStreamingConfiguration 

func (c *Client) DeleteVoiceConnectorStreamingConfiguration(ctx context.Context, params *DeleteVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorStreamingConfigurationOutput, error)

Deletes a Voice Connector's streaming configuration.

func (*Client) DeleteVoiceConnectorTermination 

func (c *Client) DeleteVoiceConnectorTermination(ctx context.Context, params *DeleteVoiceConnectorTerminationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorTerminationOutput, error)

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

func (*Client) DeleteVoiceConnectorTerminationCredentials 

func (c *Client) DeleteVoiceConnectorTerminationCredentials(ctx context.Context, params *DeleteVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*DeleteVoiceConnectorTerminationCredentialsOutput, error)

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

func (*Client) DeleteVoiceProfile added in v1.3.0 

func (c *Client) DeleteVoiceProfile(ctx context.Context, params *DeleteVoiceProfileInput, optFns ...func(*Options)) (*DeleteVoiceProfileOutput, error)

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

func (*Client) DeleteVoiceProfileDomain added in v1.3.0 

func (c *Client) DeleteVoiceProfileDomain(ctx context.Context, params *DeleteVoiceProfileDomainInput, optFns ...func(*Options)) (*DeleteVoiceProfileDomainOutput, error)

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

func (*Client) DisassociatePhoneNumbersFromVoiceConnector 

func (c *Client) DisassociatePhoneNumbersFromVoiceConnector(ctx context.Context, params *DisassociatePhoneNumbersFromVoiceConnectorInput, optFns ...func(*Options)) (*DisassociatePhoneNumbersFromVoiceConnectorOutput, error)

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

func (*Client) DisassociatePhoneNumbersFromVoiceConnectorGroup 

func (c *Client) DisassociatePhoneNumbersFromVoiceConnectorGroup(ctx context.Context, params *DisassociatePhoneNumbersFromVoiceConnectorGroupInput, optFns ...func(*Options)) (*DisassociatePhoneNumbersFromVoiceConnectorGroupOutput, error)

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

func (*Client) GetGlobalSettings 

func (c *Client) GetGlobalSettings(ctx context.Context, params *GetGlobalSettingsInput, optFns ...func(*Options)) (*GetGlobalSettingsOutput, error)

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

func (*Client) GetPhoneNumber 

func (c *Client) GetPhoneNumber(ctx context.Context, params *GetPhoneNumberInput, optFns ...func(*Options)) (*GetPhoneNumberOutput, error)

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

func (*Client) GetPhoneNumberOrder 

func (c *Client) GetPhoneNumberOrder(ctx context.Context, params *GetPhoneNumberOrderInput, optFns ...func(*Options)) (*GetPhoneNumberOrderOutput, error)

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

func (*Client) GetPhoneNumberSettings 

func (c *Client) GetPhoneNumberSettings(ctx context.Context, params *GetPhoneNumberSettingsInput, optFns ...func(*Options)) (*GetPhoneNumberSettingsOutput, error)

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

func (*Client) GetProxySession 

func (c *Client) GetProxySession(ctx context.Context, params *GetProxySessionInput, optFns ...func(*Options)) (*GetProxySessionOutput, error)

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

func (*Client) GetSipMediaApplication 

func (c *Client) GetSipMediaApplication(ctx context.Context, params *GetSipMediaApplicationInput, optFns ...func(*Options)) (*GetSipMediaApplicationOutput, error)

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

func (*Client) GetSipMediaApplicationAlexaSkillConfiguration 

func (c *Client) GetSipMediaApplicationAlexaSkillConfiguration(ctx context.Context, params *GetSipMediaApplicationAlexaSkillConfigurationInput, optFns ...func(*Options)) (*GetSipMediaApplicationAlexaSkillConfigurationOutput, error)

Gets the Alexa Skill configuration for the SIP media application.

func (*Client) GetSipMediaApplicationLoggingConfiguration 

func (c *Client) GetSipMediaApplicationLoggingConfiguration(ctx context.Context, params *GetSipMediaApplicationLoggingConfigurationInput, optFns ...func(*Options)) (*GetSipMediaApplicationLoggingConfigurationOutput, error)

Retrieves the logging configuration for the specified SIP media application.

func (*Client) GetSipRule 

func (c *Client) GetSipRule(ctx context.Context, params *GetSipRuleInput, optFns ...func(*Options)) (*GetSipRuleOutput, error)

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

func (*Client) GetSpeakerSearchTask added in v1.3.0 

func (c *Client) GetSpeakerSearchTask(ctx context.Context, params *GetSpeakerSearchTaskInput, optFns ...func(*Options)) (*GetSpeakerSearchTaskOutput, error)

Retrieves the details of the specified speaker search task.

func (*Client) GetVoiceConnector 

func (c *Client) GetVoiceConnector(ctx context.Context, params *GetVoiceConnectorInput, optFns ...func(*Options)) (*GetVoiceConnectorOutput, error)

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

func (*Client) GetVoiceConnectorEmergencyCallingConfiguration 

func (c *Client) GetVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *GetVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorEmergencyCallingConfigurationOutput, error)

Retrieves the emergency calling configuration details for the specified Voice Connector.

func (*Client) GetVoiceConnectorGroup 

func (c *Client) GetVoiceConnectorGroup(ctx context.Context, params *GetVoiceConnectorGroupInput, optFns ...func(*Options)) (*GetVoiceConnectorGroupOutput, error)

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .

func (*Client) GetVoiceConnectorLoggingConfiguration 

func (c *Client) GetVoiceConnectorLoggingConfiguration(ctx context.Context, params *GetVoiceConnectorLoggingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorLoggingConfigurationOutput, error)

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

func (*Client) GetVoiceConnectorOrigination 

func (c *Client) GetVoiceConnectorOrigination(ctx context.Context, params *GetVoiceConnectorOriginationInput, optFns ...func(*Options)) (*GetVoiceConnectorOriginationOutput, error)

Retrieves the origination settings for the specified Voice Connector.

func (*Client) GetVoiceConnectorProxy 

func (c *Client) GetVoiceConnectorProxy(ctx context.Context, params *GetVoiceConnectorProxyInput, optFns ...func(*Options)) (*GetVoiceConnectorProxyOutput, error)

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

func (*Client) GetVoiceConnectorStreamingConfiguration 

func (c *Client) GetVoiceConnectorStreamingConfiguration(ctx context.Context, params *GetVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorStreamingConfigurationOutput, error)

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

func (*Client) GetVoiceConnectorTermination 

func (c *Client) GetVoiceConnectorTermination(ctx context.Context, params *GetVoiceConnectorTerminationInput, optFns ...func(*Options)) (*GetVoiceConnectorTerminationOutput, error)

Retrieves the termination setting details for the specified Voice Connector.

func (*Client) GetVoiceConnectorTerminationHealth 

func (c *Client) GetVoiceConnectorTerminationHealth(ctx context.Context, params *GetVoiceConnectorTerminationHealthInput, optFns ...func(*Options)) (*GetVoiceConnectorTerminationHealthOutput, error)

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

func (*Client) GetVoiceProfile added in v1.3.0 

func (c *Client) GetVoiceProfile(ctx context.Context, params *GetVoiceProfileInput, optFns ...func(*Options)) (*GetVoiceProfileOutput, error)

Retrieves the details of the specified voice profile.

func (*Client) GetVoiceProfileDomain added in v1.3.0 

func (c *Client) GetVoiceProfileDomain(ctx context.Context, params *GetVoiceProfileDomainInput, optFns ...func(*Options)) (*GetVoiceProfileDomainOutput, error)

Retrieves the details of the specified voice profile domain.

func (*Client) GetVoiceToneAnalysisTask added in v1.3.0 

func (c *Client) GetVoiceToneAnalysisTask(ctx context.Context, params *GetVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*GetVoiceToneAnalysisTaskOutput, error)

Retrieves the details of a voice tone analysis task.

func (*Client) ListAvailableVoiceConnectorRegions 

func (c *Client) ListAvailableVoiceConnectorRegions(ctx context.Context, params *ListAvailableVoiceConnectorRegionsInput, optFns ...func(*Options)) (*ListAvailableVoiceConnectorRegionsOutput, error)

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

func (*Client) ListPhoneNumberOrders 

func (c *Client) ListPhoneNumberOrders(ctx context.Context, params *ListPhoneNumberOrdersInput, optFns ...func(*Options)) (*ListPhoneNumberOrdersOutput, error)

Lists the phone numbers for an administrator's Amazon Chime SDK account.

func (*Client) ListPhoneNumbers 

func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersInput, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error)

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

func (*Client) ListProxySessions 

func (c *Client) ListProxySessions(ctx context.Context, params *ListProxySessionsInput, optFns ...func(*Options)) (*ListProxySessionsOutput, error)

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

func (*Client) ListSipMediaApplications 

func (c *Client) ListSipMediaApplications(ctx context.Context, params *ListSipMediaApplicationsInput, optFns ...func(*Options)) (*ListSipMediaApplicationsOutput, error)

Lists the SIP media applications under the administrator's AWS account.

func (*Client) ListSipRules 

func (c *Client) ListSipRules(ctx context.Context, params *ListSipRulesInput, optFns ...func(*Options)) (*ListSipRulesOutput, error)

Lists the SIP rules under the administrator's AWS account.

func (*Client) ListSupportedPhoneNumberCountries 

func (c *Client) ListSupportedPhoneNumberCountries(ctx context.Context, params *ListSupportedPhoneNumberCountriesInput, optFns ...func(*Options)) (*ListSupportedPhoneNumberCountriesOutput, error)

Lists the countries that you can order phone numbers from.

func (*Client) ListTagsForResource added in v1.3.0 

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

Returns a list of the tags in a given resource.

func (*Client) ListVoiceConnectorGroups 

func (c *Client) ListVoiceConnectorGroups(ctx context.Context, params *ListVoiceConnectorGroupsInput, optFns ...func(*Options)) (*ListVoiceConnectorGroupsOutput, error)

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

func (*Client) ListVoiceConnectorTerminationCredentials 

func (c *Client) ListVoiceConnectorTerminationCredentials(ctx context.Context, params *ListVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*ListVoiceConnectorTerminationCredentialsOutput, error)

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

func (*Client) ListVoiceConnectors 

func (c *Client) ListVoiceConnectors(ctx context.Context, params *ListVoiceConnectorsInput, optFns ...func(*Options)) (*ListVoiceConnectorsOutput, error)

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

func (*Client) ListVoiceProfileDomains added in v1.3.0 

func (c *Client) ListVoiceProfileDomains(ctx context.Context, params *ListVoiceProfileDomainsInput, optFns ...func(*Options)) (*ListVoiceProfileDomainsOutput, error)

Lists the specified voice profile domains in the administrator's AWS account.

func (*Client) ListVoiceProfiles added in v1.3.0 

func (c *Client) ListVoiceProfiles(ctx context.Context, params *ListVoiceProfilesInput, optFns ...func(*Options)) (*ListVoiceProfilesOutput, error)

Lists the voice profiles in a voice profile domain.

func (*Client) Options added in v1.12.0 

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

func (c *Client) PutSipMediaApplicationAlexaSkillConfiguration(ctx context.Context, params *PutSipMediaApplicationAlexaSkillConfigurationInput, optFns ...func(*Options)) (*PutSipMediaApplicationAlexaSkillConfigurationOutput, error)

Updates the Alexa Skill configuration for the SIP media application.

func (*Client) PutSipMediaApplicationLoggingConfiguration 

func (c *Client) PutSipMediaApplicationLoggingConfiguration(ctx context.Context, params *PutSipMediaApplicationLoggingConfigurationInput, optFns ...func(*Options)) (*PutSipMediaApplicationLoggingConfigurationOutput, error)

Updates the logging configuration for the specified SIP media application.

func (*Client) PutVoiceConnectorEmergencyCallingConfiguration 

func (c *Client) PutVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *PutVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorEmergencyCallingConfigurationOutput, error)

Updates a Voice Connector's emergency calling configuration.

func (*Client) PutVoiceConnectorLoggingConfiguration 

func (c *Client) PutVoiceConnectorLoggingConfiguration(ctx context.Context, params *PutVoiceConnectorLoggingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorLoggingConfigurationOutput, error)

Updates a Voice Connector's logging configuration.

func (*Client) PutVoiceConnectorOrigination 

func (c *Client) PutVoiceConnectorOrigination(ctx context.Context, params *PutVoiceConnectorOriginationInput, optFns ...func(*Options)) (*PutVoiceConnectorOriginationOutput, error)

Updates a Voice Connector's origination settings.

func (*Client) PutVoiceConnectorProxy 

func (c *Client) PutVoiceConnectorProxy(ctx context.Context, params *PutVoiceConnectorProxyInput, optFns ...func(*Options)) (*PutVoiceConnectorProxyOutput, error)

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

func (*Client) PutVoiceConnectorStreamingConfiguration 

func (c *Client) PutVoiceConnectorStreamingConfiguration(ctx context.Context, params *PutVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorStreamingConfigurationOutput, error)

Updates a Voice Connector's streaming configuration settings.

func (*Client) PutVoiceConnectorTermination 

func (c *Client) PutVoiceConnectorTermination(ctx context.Context, params *PutVoiceConnectorTerminationInput, optFns ...func(*Options)) (*PutVoiceConnectorTerminationOutput, error)

Updates a Voice Connector's termination settings.

func (*Client) PutVoiceConnectorTerminationCredentials 

func (c *Client) PutVoiceConnectorTerminationCredentials(ctx context.Context, params *PutVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*PutVoiceConnectorTerminationCredentialsOutput, error)

Updates a Voice Connector's termination credentials.

func (*Client) RestorePhoneNumber 

func (c *Client) RestorePhoneNumber(ctx context.Context, params *RestorePhoneNumberInput, optFns ...func(*Options)) (*RestorePhoneNumberOutput, error)

Restores a deleted phone number.

func (*Client) SearchAvailablePhoneNumbers 

func (c *Client) SearchAvailablePhoneNumbers(ctx context.Context, params *SearchAvailablePhoneNumbersInput, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)

Searches the provisioned phone numbers in an organization.

func (*Client) StartSpeakerSearchTask added in v1.3.0 

func (c *Client) StartSpeakerSearchTask(ctx context.Context, params *StartSpeakerSearchTaskInput, optFns ...func(*Options)) (*StartSpeakerSearchTaskOutput, error)

Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

func (*Client) StartVoiceToneAnalysisTask added in v1.3.0 

func (c *Client) StartVoiceToneAnalysisTask(ctx context.Context, params *StartVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*StartVoiceToneAnalysisTaskOutput, error)

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

func (*Client) StopSpeakerSearchTask added in v1.3.0 

func (c *Client) StopSpeakerSearchTask(ctx context.Context, params *StopSpeakerSearchTaskInput, optFns ...func(*Options)) (*StopSpeakerSearchTaskOutput, error)

Stops a speaker search task.

func (*Client) StopVoiceToneAnalysisTask added in v1.3.0 

func (c *Client) StopVoiceToneAnalysisTask(ctx context.Context, params *StopVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*StopVoiceToneAnalysisTaskOutput, error)

Stops a voice tone analysis task.

func (*Client) TagResource added in v1.3.0 

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

Adds a tag to the specified resource.

func (*Client) UntagResource added in v1.3.0 

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

Removes tags from a resource.

func (*Client) UpdateGlobalSettings 

func (c *Client) UpdateGlobalSettings(ctx context.Context, params *UpdateGlobalSettingsInput, optFns ...func(*Options)) (*UpdateGlobalSettingsOutput, error)

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

func (*Client) UpdatePhoneNumber 

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

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

func (*Client) UpdatePhoneNumberSettings 

func (c *Client) UpdatePhoneNumberSettings(ctx context.Context, params *UpdatePhoneNumberSettingsInput, optFns ...func(*Options)) (*UpdatePhoneNumberSettingsOutput, error)

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

func (*Client) UpdateProxySession 

func (c *Client) UpdateProxySession(ctx context.Context, params *UpdateProxySessionInput, optFns ...func(*Options)) (*UpdateProxySessionOutput, error)

Updates the specified proxy session details, such as voice or SMS capabilities.

func (*Client) UpdateSipMediaApplication 

func (c *Client) UpdateSipMediaApplication(ctx context.Context, params *UpdateSipMediaApplicationInput, optFns ...func(*Options)) (*UpdateSipMediaApplicationOutput, error)

Updates the details of the specified SIP media application.

func (*Client) UpdateSipMediaApplicationCall 

func (c *Client) UpdateSipMediaApplicationCall(ctx context.Context, params *UpdateSipMediaApplicationCallInput, optFns ...func(*Options)) (*UpdateSipMediaApplicationCallOutput, error)

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

func (*Client) UpdateSipRule 

func (c *Client) UpdateSipRule(ctx context.Context, params *UpdateSipRuleInput, optFns ...func(*Options)) (*UpdateSipRuleOutput, error)

Updates the details of the specified SIP rule.

func (*Client) UpdateVoiceConnector 

func (c *Client) UpdateVoiceConnector(ctx context.Context, params *UpdateVoiceConnectorInput, optFns ...func(*Options)) (*UpdateVoiceConnectorOutput, error)

Updates the details for the specified Amazon Chime SDK Voice Connector.

func (*Client) UpdateVoiceConnectorGroup 

func (c *Client) UpdateVoiceConnectorGroup(ctx context.Context, params *UpdateVoiceConnectorGroupInput, optFns ...func(*Options)) (*UpdateVoiceConnectorGroupOutput, error)

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

func (*Client) UpdateVoiceProfile added in v1.3.0 

func (c *Client) UpdateVoiceProfile(ctx context.Context, params *UpdateVoiceProfileInput, optFns ...func(*Options)) (*UpdateVoiceProfileOutput, error)

Updates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws. You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

func (*Client) UpdateVoiceProfileDomain added in v1.3.0 

func (c *Client) UpdateVoiceProfileDomain(ctx context.Context, params *UpdateVoiceProfileDomainInput, optFns ...func(*Options)) (*UpdateVoiceProfileDomainOutput, error)

Updates the settings for the specified voice profile domain.

func (*Client) ValidateE911Address 

func (c *Client) ValidateE911Address(ctx context.Context, params *ValidateE911AddressInput, optFns ...func(*Options)) (*ValidateE911AddressOutput, error)

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

type CreatePhoneNumberOrderInput 

type CreatePhoneNumberOrderInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The phone number product type.
	//
	// This member is required.
	ProductType types.PhoneNumberProductType

	// Specifies the name assigned to one or more phone numbers.
	Name *string
	// contains filtered or unexported fields
}

type CreatePhoneNumberOrderOutput 

type CreatePhoneNumberOrderOutput struct {

	// The phone number order details.
	PhoneNumberOrder *types.PhoneNumberOrder

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

type CreateProxySessionInput 

type CreateProxySessionInput struct {

	// The proxy session's capabilities.
	//
	// This member is required.
	Capabilities []types.Capability

	// The participant phone numbers.
	//
	// This member is required.
	ParticipantPhoneNumbers []string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The number of minutes allowed for the proxy session.
	ExpiryMinutes *int32

	// The preference for matching the country or area code of the proxy phone number
	// with that of the first participant.
	GeoMatchLevel types.GeoMatchLevel

	// The country and area code for the proxy phone number.
	GeoMatchParams *types.GeoMatchParams

	// The name of the proxy session.
	Name *string

	// The preference for proxy phone number reuse, or stickiness, between the same
	// participants across sessions.
	NumberSelectionBehavior types.NumberSelectionBehavior
	// contains filtered or unexported fields
}

type CreateProxySessionOutput 

type CreateProxySessionOutput struct {

	// The proxy session details.
	ProxySession *types.ProxySession

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

type CreateSipMediaApplicationCallInput 

type CreateSipMediaApplicationCallInput struct {

	// The phone number that a user calls from. This is a phone number in your Amazon
	// Chime SDK phone number inventory.
	//
	// This member is required.
	FromPhoneNumber *string

	// The ID of the SIP media application.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The phone number that the service should call.
	//
	// This member is required.
	ToPhoneNumber *string

	// Context passed to a CreateSipMediaApplication API call. For example, you could
	// pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"
	ArgumentsMap map[string]string

	// The SIP headers added to an outbound call leg.
	SipHeaders map[string]string
	// contains filtered or unexported fields
}

type CreateSipMediaApplicationCallOutput 

type CreateSipMediaApplicationCallOutput struct {

	// The actual call.
	SipMediaApplicationCall *types.SipMediaApplicationCall

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

type CreateSipMediaApplicationInput 

type CreateSipMediaApplicationInput struct {

	// The AWS Region assigned to the SIP media application.
	//
	// This member is required.
	AwsRegion *string

	// List of endpoints (Lambda ARNs) specified for the SIP media application.
	//
	// This member is required.
	Endpoints []types.SipMediaApplicationEndpoint

	// The SIP media application's name.
	//
	// This member is required.
	Name *string

	// The tags assigned to the SIP media application.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateSipMediaApplicationOutput 

type CreateSipMediaApplicationOutput struct {

	// The SIP media application details.
	SipMediaApplication *types.SipMediaApplication

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

type CreateSipRuleInput 

type CreateSipRuleInput struct {

	// The name of the SIP rule.
	//
	// This member is required.
	Name *string

	// The type of trigger assigned to the SIP rule in TriggerValue , currently
	// RequestUriHostname or ToPhoneNumber .
	//
	// This member is required.
	TriggerType types.SipRuleTriggerType

	// If TriggerType is RequestUriHostname , the value can be the outbound host name
	// of a Voice Connector. If TriggerType is ToPhoneNumber , the value can be a
	// customer-owned phone number in the E164 format. The SipMediaApplication
	// specified in the SipRule is triggered if the request URI in an incoming SIP
	// request matches the RequestUriHostname , or if the To header in the incoming
	// SIP request matches the ToPhoneNumber value.
	//
	// This member is required.
	TriggerValue *string

	// Disables or enables a SIP rule. You must disable SIP rules before you can
	// delete them.
	Disabled *bool

	// List of SIP media applications, with priority and AWS Region. Only one SIP
	// application per AWS Region can be used.
	TargetApplications []types.SipRuleTargetApplication
	// contains filtered or unexported fields
}

type CreateSipRuleOutput 

type CreateSipRuleOutput struct {

	// The SIP rule information, including the rule ID, triggers, and target
	// applications.
	SipRule *types.SipRule

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

type CreateVoiceConnectorGroupInput 

type CreateVoiceConnectorGroupInput struct {

	// The name of the Voice Connector group.
	//
	// This member is required.
	Name *string

	// Lists the Voice Connectors that inbound calls are routed to.
	VoiceConnectorItems []types.VoiceConnectorItem
	// contains filtered or unexported fields
}

type CreateVoiceConnectorGroupOutput 

type CreateVoiceConnectorGroupOutput struct {

	// The details of the Voice Connector group.
	VoiceConnectorGroup *types.VoiceConnectorGroup

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

type CreateVoiceConnectorInput 

type CreateVoiceConnectorInput struct {

	// The name of the Voice Connector.
	//
	// This member is required.
	Name *string

	// Enables or disables encryption for the Voice Connector.
	//
	// This member is required.
	RequireEncryption *bool

	// The AWS Region in which the Amazon Chime SDK Voice Connector is created.
	// Default value: us-east-1 .
	AwsRegion types.VoiceConnectorAwsRegion

	// The tags assigned to the Voice Connector.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateVoiceConnectorOutput 

type CreateVoiceConnectorOutput struct {

	// The details of the Voice Connector.
	VoiceConnector *types.VoiceConnector

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

type CreateVoiceProfileDomainInput added in v1.3.0 

type CreateVoiceProfileDomainInput struct {

	// The name of the voice profile domain.
	//
	// This member is required.
	Name *string

	// The server-side encryption configuration for the request.
	//
	// This member is required.
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

	// The unique identifier for the client request. Use a different token for
	// different domain creation requests.
	ClientRequestToken *string

	// A description of the voice profile domain.
	Description *string

	// The tags assigned to the domain.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateVoiceProfileDomainOutput added in v1.3.0 

type CreateVoiceProfileDomainOutput struct {

	// The requested voice profile domain.
	VoiceProfileDomain *types.VoiceProfileDomain

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

type CreateVoiceProfileInput added in v1.3.0 

type CreateVoiceProfileInput struct {

	// The ID of the speaker search task.
	//
	// This member is required.
	SpeakerSearchTaskId *string
	// contains filtered or unexported fields
}

type CreateVoiceProfileOutput added in v1.3.0 

type CreateVoiceProfileOutput struct {

	// The requested voice profile.
	VoiceProfile *types.VoiceProfile

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

type DeletePhoneNumberInput 

type DeletePhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type DeletePhoneNumberOutput 

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

type DeleteProxySessionInput 

type DeleteProxySessionInput struct {

	// The proxy session ID.
	//
	// This member is required.
	ProxySessionId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteProxySessionOutput 

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

type DeleteSipMediaApplicationInput 

type DeleteSipMediaApplicationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

type DeleteSipMediaApplicationOutput 

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

type DeleteSipRuleInput 

type DeleteSipRuleInput struct {

	// The SIP rule ID.
	//
	// This member is required.
	SipRuleId *string
	// contains filtered or unexported fields
}

type DeleteSipRuleOutput 

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

type DeleteVoiceConnectorEmergencyCallingConfigurationInput 

type DeleteVoiceConnectorEmergencyCallingConfigurationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorEmergencyCallingConfigurationOutput 

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

type DeleteVoiceConnectorGroupInput 

type DeleteVoiceConnectorGroupInput struct {

	// The Voice Connector Group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorGroupOutput 

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

type DeleteVoiceConnectorInput 

type DeleteVoiceConnectorInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorOriginationInput 

type DeleteVoiceConnectorOriginationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorOriginationOutput 

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

type DeleteVoiceConnectorOutput 

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

type DeleteVoiceConnectorProxyInput 

type DeleteVoiceConnectorProxyInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorProxyOutput 

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

type DeleteVoiceConnectorStreamingConfigurationInput 

type DeleteVoiceConnectorStreamingConfigurationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorStreamingConfigurationOutput 

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

type DeleteVoiceConnectorTerminationCredentialsInput 

type DeleteVoiceConnectorTerminationCredentialsInput struct {

	// The RFC2617 compliant username associated with the SIP credentials, in US-ASCII
	// format.
	//
	// This member is required.
	Usernames []string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorTerminationCredentialsOutput 

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

type DeleteVoiceConnectorTerminationInput 

type DeleteVoiceConnectorTerminationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DeleteVoiceConnectorTerminationOutput 

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

type DeleteVoiceProfileDomainInput added in v1.3.0 

type DeleteVoiceProfileDomainInput struct {

	// The voice profile domain ID.
	//
	// This member is required.
	VoiceProfileDomainId *string
	// contains filtered or unexported fields
}

type DeleteVoiceProfileDomainOutput added in v1.3.0 

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

type DeleteVoiceProfileInput added in v1.3.0 

type DeleteVoiceProfileInput struct {

	// The voice profile ID.
	//
	// This member is required.
	VoiceProfileId *string
	// contains filtered or unexported fields
}

type DeleteVoiceProfileOutput added in v1.3.0 

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

type DisassociatePhoneNumbersFromVoiceConnectorGroupInput 

type DisassociatePhoneNumbersFromVoiceConnectorGroupInput struct {

	// The list of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string
	// contains filtered or unexported fields
}

type DisassociatePhoneNumbersFromVoiceConnectorGroupOutput 

type DisassociatePhoneNumbersFromVoiceConnectorGroupOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

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

type DisassociatePhoneNumbersFromVoiceConnectorInput 

type DisassociatePhoneNumbersFromVoiceConnectorInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type DisassociatePhoneNumbersFromVoiceConnectorOutput 

type DisassociatePhoneNumbersFromVoiceConnectorOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

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

type EndpointParameters added in v1.7.0 

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 added in v1.7.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.7.0 

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 added in v1.7.0 

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 added in v1.7.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetGlobalSettingsInput 

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

type GetGlobalSettingsOutput 

type GetGlobalSettingsOutput struct {

	// The Voice Connector settings.
	VoiceConnector *types.VoiceConnectorSettings

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

type GetPhoneNumberInput 

type GetPhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type GetPhoneNumberOrderInput 

type GetPhoneNumberOrderInput struct {

	// The ID of the phone number order .
	//
	// This member is required.
	PhoneNumberOrderId *string
	// contains filtered or unexported fields
}

type GetPhoneNumberOrderOutput 

type GetPhoneNumberOrderOutput struct {

	// The phone number order details.
	PhoneNumberOrder *types.PhoneNumberOrder

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

type GetPhoneNumberOutput 

type GetPhoneNumberOutput struct {

	// The phone number details.
	PhoneNumber *types.PhoneNumber

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

type GetPhoneNumberSettingsInput 

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

type GetPhoneNumberSettingsOutput 

type GetPhoneNumberSettingsOutput struct {

	// The default outbound calling name for the account.
	CallingName *string

	// The updated outbound calling name timestamp, in ISO 8601 format.
	CallingNameUpdatedTimestamp *time.Time

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

type GetProxySessionInput 

type GetProxySessionInput struct {

	// The proxy session ID.
	//
	// This member is required.
	ProxySessionId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetProxySessionOutput 

type GetProxySessionOutput struct {

	// The proxy session details.
	ProxySession *types.ProxySession

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

type GetSipMediaApplicationAlexaSkillConfigurationInput 

type GetSipMediaApplicationAlexaSkillConfigurationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

type GetSipMediaApplicationAlexaSkillConfigurationOutput 

type GetSipMediaApplicationAlexaSkillConfigurationOutput struct {

	// Returns the Alexa Skill configuration.
	SipMediaApplicationAlexaSkillConfiguration *types.SipMediaApplicationAlexaSkillConfiguration

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

type GetSipMediaApplicationInput 

type GetSipMediaApplicationInput struct {

	// The SIP media application ID .
	//
	// This member is required.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

type GetSipMediaApplicationLoggingConfigurationInput 

type GetSipMediaApplicationLoggingConfigurationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

type GetSipMediaApplicationLoggingConfigurationOutput 

type GetSipMediaApplicationLoggingConfigurationOutput struct {

	// The actual logging configuration.
	SipMediaApplicationLoggingConfiguration *types.SipMediaApplicationLoggingConfiguration

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

type GetSipMediaApplicationOutput 

type GetSipMediaApplicationOutput struct {

	// The details of the SIP media application.
	SipMediaApplication *types.SipMediaApplication

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

type GetSipRuleInput 

type GetSipRuleInput struct {

	// The SIP rule ID.
	//
	// This member is required.
	SipRuleId *string
	// contains filtered or unexported fields
}

type GetSipRuleOutput 

type GetSipRuleOutput struct {

	// The SIP rule details.
	SipRule *types.SipRule

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

type GetSpeakerSearchTaskInput added in v1.3.0 

type GetSpeakerSearchTaskInput struct {

	// The ID of the speaker search task.
	//
	// This member is required.
	SpeakerSearchTaskId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetSpeakerSearchTaskOutput added in v1.3.0 

type GetSpeakerSearchTaskOutput struct {

	// The details of the speaker search task.
	SpeakerSearchTask *types.SpeakerSearchTask

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

type GetVoiceConnectorEmergencyCallingConfigurationInput 

type GetVoiceConnectorEmergencyCallingConfigurationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorEmergencyCallingConfigurationOutput 

type GetVoiceConnectorEmergencyCallingConfigurationOutput struct {

	// The details of the emergency calling configuration.
	EmergencyCallingConfiguration *types.EmergencyCallingConfiguration

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

type GetVoiceConnectorGroupInput 

type GetVoiceConnectorGroupInput struct {

	// The Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorGroupOutput 

type GetVoiceConnectorGroupOutput struct {

	// The details of the Voice Connector group.
	VoiceConnectorGroup *types.VoiceConnectorGroup

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

type GetVoiceConnectorInput 

type GetVoiceConnectorInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorLoggingConfigurationInput 

type GetVoiceConnectorLoggingConfigurationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorLoggingConfigurationOutput 

type GetVoiceConnectorLoggingConfigurationOutput struct {

	// The logging configuration details .
	LoggingConfiguration *types.LoggingConfiguration

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

type GetVoiceConnectorOriginationInput 

type GetVoiceConnectorOriginationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorOriginationOutput 

type GetVoiceConnectorOriginationOutput struct {

	// The origination setting details.
	Origination *types.Origination

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

type GetVoiceConnectorOutput 

type GetVoiceConnectorOutput struct {

	// The Voice Connector details.
	VoiceConnector *types.VoiceConnector

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

type GetVoiceConnectorProxyInput 

type GetVoiceConnectorProxyInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorProxyOutput 

type GetVoiceConnectorProxyOutput struct {

	// The proxy configuration details.
	Proxy *types.Proxy

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

type GetVoiceConnectorStreamingConfigurationInput 

type GetVoiceConnectorStreamingConfigurationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorStreamingConfigurationOutput 

type GetVoiceConnectorStreamingConfigurationOutput struct {

	// The details of the streaming configuration.
	StreamingConfiguration *types.StreamingConfiguration

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

type GetVoiceConnectorTerminationHealthInput 

type GetVoiceConnectorTerminationHealthInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorTerminationHealthOutput 

type GetVoiceConnectorTerminationHealthOutput struct {

	// The termination health details.
	TerminationHealth *types.TerminationHealth

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

type GetVoiceConnectorTerminationInput 

type GetVoiceConnectorTerminationInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type GetVoiceConnectorTerminationOutput 

type GetVoiceConnectorTerminationOutput struct {

	// The termination setting details.
	Termination *types.Termination

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

type GetVoiceProfileDomainInput added in v1.3.0 

type GetVoiceProfileDomainInput struct {

	// The voice profile domain ID.
	//
	// This member is required.
	VoiceProfileDomainId *string
	// contains filtered or unexported fields
}

type GetVoiceProfileDomainOutput added in v1.3.0 

type GetVoiceProfileDomainOutput struct {

	// The details of the voice profile domain.
	VoiceProfileDomain *types.VoiceProfileDomain

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

type GetVoiceProfileInput added in v1.3.0 

type GetVoiceProfileInput struct {

	// The voice profile ID.
	//
	// This member is required.
	VoiceProfileId *string
	// contains filtered or unexported fields
}

type GetVoiceProfileOutput added in v1.3.0 

type GetVoiceProfileOutput struct {

	// The voice profile details.
	VoiceProfile *types.VoiceProfile

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

type GetVoiceToneAnalysisTaskInput added in v1.3.0 

type GetVoiceToneAnalysisTaskInput struct {

	// Specifies whether the voice being analyzed is the caller (originator) or the
	// callee (responder).
	//
	// This member is required.
	IsCaller *bool

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The ID of the voice tone anlysis task.
	//
	// This member is required.
	VoiceToneAnalysisTaskId *string
	// contains filtered or unexported fields
}

type GetVoiceToneAnalysisTaskOutput added in v1.3.0 

type GetVoiceToneAnalysisTaskOutput struct {

	// The details of the voice tone analysis task.
	VoiceToneAnalysisTask *types.VoiceToneAnalysisTask

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

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

type ListAvailableVoiceConnectorRegionsOutput 

type ListAvailableVoiceConnectorRegionsOutput struct {

	// The list of AWS Regions.
	VoiceConnectorRegions []types.VoiceConnectorAwsRegion

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

type ListPhoneNumberOrdersAPIClient 

type ListPhoneNumberOrdersAPIClient interface {
	ListPhoneNumberOrders(context.Context, *ListPhoneNumberOrdersInput, ...func(*Options)) (*ListPhoneNumberOrdersOutput, error)
}

ListPhoneNumberOrdersAPIClient is a client that implements the ListPhoneNumberOrders operation.

type ListPhoneNumberOrdersInput 

type ListPhoneNumberOrdersInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to retrieve the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPhoneNumberOrdersOutput 

type ListPhoneNumberOrdersOutput struct {

	// The token used to retrieve the next page of results.
	NextToken *string

	// The phone number order details.
	PhoneNumberOrders []types.PhoneNumberOrder

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

type ListPhoneNumberOrdersPaginator 

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

ListPhoneNumberOrdersPaginator is a paginator for ListPhoneNumberOrders

func NewListPhoneNumberOrdersPaginator 

func NewListPhoneNumberOrdersPaginator(client ListPhoneNumberOrdersAPIClient, params *ListPhoneNumberOrdersInput, optFns ...func(*ListPhoneNumberOrdersPaginatorOptions)) *ListPhoneNumberOrdersPaginator

NewListPhoneNumberOrdersPaginator returns a new ListPhoneNumberOrdersPaginator

func (*ListPhoneNumberOrdersPaginator) HasMorePages 

func (p *ListPhoneNumberOrdersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumberOrdersPaginator) NextPage 

func (p *ListPhoneNumberOrdersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPhoneNumberOrdersOutput, error)

NextPage retrieves the next ListPhoneNumberOrders page.

type ListPhoneNumberOrdersPaginatorOptions 

type ListPhoneNumberOrdersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListPhoneNumberOrdersPaginatorOptions is the paginator options for ListPhoneNumberOrders

type ListPhoneNumbersAPIClient 

type ListPhoneNumbersAPIClient interface {
	ListPhoneNumbers(context.Context, *ListPhoneNumbersInput, ...func(*Options)) (*ListPhoneNumbersOutput, error)
}

ListPhoneNumbersAPIClient is a client that implements the ListPhoneNumbers operation.

type ListPhoneNumbersInput 

type ListPhoneNumbersInput struct {

	// The filter to limit the number of results.
	FilterName types.PhoneNumberAssociationName

	// The filter value.
	FilterValue *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string

	// The phone number product types.
	ProductType types.PhoneNumberProductType

	// The status of your organization's phone numbers.
	Status *string
	// contains filtered or unexported fields
}

type ListPhoneNumbersOutput 

type ListPhoneNumbersOutput struct {

	// The token used to return the next page of results.
	NextToken *string

	// The phone number details.
	PhoneNumbers []types.PhoneNumber

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

type ListPhoneNumbersPaginator 

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

ListPhoneNumbersPaginator is a paginator for ListPhoneNumbers

func NewListPhoneNumbersPaginator 

func NewListPhoneNumbersPaginator(client ListPhoneNumbersAPIClient, params *ListPhoneNumbersInput, optFns ...func(*ListPhoneNumbersPaginatorOptions)) *ListPhoneNumbersPaginator

NewListPhoneNumbersPaginator returns a new ListPhoneNumbersPaginator

func (*ListPhoneNumbersPaginator) HasMorePages 

func (p *ListPhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumbersPaginator) NextPage 

func (p *ListPhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error)

NextPage retrieves the next ListPhoneNumbers page.

type ListPhoneNumbersPaginatorOptions 

type ListPhoneNumbersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListPhoneNumbersPaginatorOptions is the paginator options for ListPhoneNumbers

type ListProxySessionsAPIClient 

type ListProxySessionsAPIClient interface {
	ListProxySessions(context.Context, *ListProxySessionsInput, ...func(*Options)) (*ListProxySessionsOutput, error)
}

ListProxySessionsAPIClient is a client that implements the ListProxySessions operation.

type ListProxySessionsInput 

type ListProxySessionsInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to retrieve the next page of results.
	NextToken *string

	// The proxy session status.
	Status types.ProxySessionStatus
	// contains filtered or unexported fields
}

type ListProxySessionsOutput 

type ListProxySessionsOutput struct {

	// The token used to retrieve the next page of results.
	NextToken *string

	// The proxy sessions' details.
	ProxySessions []types.ProxySession

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

type ListProxySessionsPaginator 

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

ListProxySessionsPaginator is a paginator for ListProxySessions

func NewListProxySessionsPaginator 

func NewListProxySessionsPaginator(client ListProxySessionsAPIClient, params *ListProxySessionsInput, optFns ...func(*ListProxySessionsPaginatorOptions)) *ListProxySessionsPaginator

NewListProxySessionsPaginator returns a new ListProxySessionsPaginator

func (*ListProxySessionsPaginator) HasMorePages 

func (p *ListProxySessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProxySessionsPaginator) NextPage 

func (p *ListProxySessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProxySessionsOutput, error)

NextPage retrieves the next ListProxySessions page.

type ListProxySessionsPaginatorOptions 

type ListProxySessionsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListProxySessionsPaginatorOptions is the paginator options for ListProxySessions

type ListSipMediaApplicationsAPIClient 

type ListSipMediaApplicationsAPIClient interface {
	ListSipMediaApplications(context.Context, *ListSipMediaApplicationsInput, ...func(*Options)) (*ListSipMediaApplicationsOutput, error)
}

ListSipMediaApplicationsAPIClient is a client that implements the ListSipMediaApplications operation.

type ListSipMediaApplicationsInput 

type ListSipMediaApplicationsInput struct {

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSipMediaApplicationsOutput 

type ListSipMediaApplicationsOutput struct {

	// The token used to return the next page of results.
	NextToken *string

	// The list of SIP media applications and application details.
	SipMediaApplications []types.SipMediaApplication

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

type ListSipMediaApplicationsPaginator 

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

ListSipMediaApplicationsPaginator is a paginator for ListSipMediaApplications

func NewListSipMediaApplicationsPaginator 

func NewListSipMediaApplicationsPaginator(client ListSipMediaApplicationsAPIClient, params *ListSipMediaApplicationsInput, optFns ...func(*ListSipMediaApplicationsPaginatorOptions)) *ListSipMediaApplicationsPaginator

NewListSipMediaApplicationsPaginator returns a new ListSipMediaApplicationsPaginator

func (*ListSipMediaApplicationsPaginator) HasMorePages 

func (p *ListSipMediaApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSipMediaApplicationsPaginator) NextPage 

func (p *ListSipMediaApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSipMediaApplicationsOutput, error)

NextPage retrieves the next ListSipMediaApplications page.

type ListSipMediaApplicationsPaginatorOptions 

type ListSipMediaApplicationsPaginatorOptions struct {
	// The maximum number of results to return in a single call. Defaults to 100.
	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
}

ListSipMediaApplicationsPaginatorOptions is the paginator options for ListSipMediaApplications

type ListSipRulesAPIClient 

type ListSipRulesAPIClient interface {
	ListSipRules(context.Context, *ListSipRulesInput, ...func(*Options)) (*ListSipRulesOutput, error)
}

ListSipRulesAPIClient is a client that implements the ListSipRules operation.

type ListSipRulesInput 

type ListSipRulesInput struct {

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string

	// The SIP media application ID.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

type ListSipRulesOutput 

type ListSipRulesOutput struct {

	// The token used to return the next page of results.
	NextToken *string

	// The list of SIP rules and details.
	SipRules []types.SipRule

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

type ListSipRulesPaginator 

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

ListSipRulesPaginator is a paginator for ListSipRules

func NewListSipRulesPaginator 

func NewListSipRulesPaginator(client ListSipRulesAPIClient, params *ListSipRulesInput, optFns ...func(*ListSipRulesPaginatorOptions)) *ListSipRulesPaginator

NewListSipRulesPaginator returns a new ListSipRulesPaginator

func (*ListSipRulesPaginator) HasMorePages 

func (p *ListSipRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSipRulesPaginator) NextPage 

func (p *ListSipRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSipRulesOutput, error)

NextPage retrieves the next ListSipRules page.

type ListSipRulesPaginatorOptions 

type ListSipRulesPaginatorOptions struct {
	// The maximum number of results to return in a single call. Defaults to 100.
	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
}

ListSipRulesPaginatorOptions is the paginator options for ListSipRules

type ListSupportedPhoneNumberCountriesInput 

type ListSupportedPhoneNumberCountriesInput struct {

	// The phone number product type.
	//
	// This member is required.
	ProductType types.PhoneNumberProductType
	// contains filtered or unexported fields
}

type ListSupportedPhoneNumberCountriesOutput 

type ListSupportedPhoneNumberCountriesOutput struct {

	// The supported phone number countries.
	PhoneNumberCountries []types.PhoneNumberCountry

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

type ListTagsForResourceInput added in v1.3.0 

type ListTagsForResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.3.0 

type ListTagsForResourceOutput struct {

	// The tags in the list.
	Tags []types.Tag

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

type ListVoiceConnectorGroupsAPIClient 

type ListVoiceConnectorGroupsAPIClient interface {
	ListVoiceConnectorGroups(context.Context, *ListVoiceConnectorGroupsInput, ...func(*Options)) (*ListVoiceConnectorGroupsOutput, error)
}

ListVoiceConnectorGroupsAPIClient is a client that implements the ListVoiceConnectorGroups operation.

type ListVoiceConnectorGroupsInput 

type ListVoiceConnectorGroupsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVoiceConnectorGroupsOutput 

type ListVoiceConnectorGroupsOutput struct {

	// The token used to return the next page of results.
	NextToken *string

	// The details of the Voice Connector groups.
	VoiceConnectorGroups []types.VoiceConnectorGroup

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

type ListVoiceConnectorGroupsPaginator 

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

ListVoiceConnectorGroupsPaginator is a paginator for ListVoiceConnectorGroups

func NewListVoiceConnectorGroupsPaginator 

func NewListVoiceConnectorGroupsPaginator(client ListVoiceConnectorGroupsAPIClient, params *ListVoiceConnectorGroupsInput, optFns ...func(*ListVoiceConnectorGroupsPaginatorOptions)) *ListVoiceConnectorGroupsPaginator

NewListVoiceConnectorGroupsPaginator returns a new ListVoiceConnectorGroupsPaginator

func (*ListVoiceConnectorGroupsPaginator) HasMorePages 

func (p *ListVoiceConnectorGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVoiceConnectorGroupsPaginator) NextPage 

func (p *ListVoiceConnectorGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVoiceConnectorGroupsOutput, error)

NextPage retrieves the next ListVoiceConnectorGroups page.

type ListVoiceConnectorGroupsPaginatorOptions 

type ListVoiceConnectorGroupsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListVoiceConnectorGroupsPaginatorOptions is the paginator options for ListVoiceConnectorGroups

type ListVoiceConnectorTerminationCredentialsInput 

type ListVoiceConnectorTerminationCredentialsInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type ListVoiceConnectorTerminationCredentialsOutput 

type ListVoiceConnectorTerminationCredentialsOutput struct {

	// A list of user names.
	Usernames []string

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

type ListVoiceConnectorsAPIClient 

type ListVoiceConnectorsAPIClient interface {
	ListVoiceConnectors(context.Context, *ListVoiceConnectorsInput, ...func(*Options)) (*ListVoiceConnectorsOutput, error)
}

ListVoiceConnectorsAPIClient is a client that implements the ListVoiceConnectors operation.

type ListVoiceConnectorsInput 

type ListVoiceConnectorsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVoiceConnectorsOutput 

type ListVoiceConnectorsOutput struct {

	// The token used to return the next page of results.
	NextToken *string

	// The details of the Voice Connectors.
	VoiceConnectors []types.VoiceConnector

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

type ListVoiceConnectorsPaginator 

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

ListVoiceConnectorsPaginator is a paginator for ListVoiceConnectors

func NewListVoiceConnectorsPaginator 

func NewListVoiceConnectorsPaginator(client ListVoiceConnectorsAPIClient, params *ListVoiceConnectorsInput, optFns ...func(*ListVoiceConnectorsPaginatorOptions)) *ListVoiceConnectorsPaginator

NewListVoiceConnectorsPaginator returns a new ListVoiceConnectorsPaginator

func (*ListVoiceConnectorsPaginator) HasMorePages 

func (p *ListVoiceConnectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVoiceConnectorsPaginator) NextPage 

func (p *ListVoiceConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVoiceConnectorsOutput, error)

NextPage retrieves the next ListVoiceConnectors page.

type ListVoiceConnectorsPaginatorOptions 

type ListVoiceConnectorsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListVoiceConnectorsPaginatorOptions is the paginator options for ListVoiceConnectors

type ListVoiceProfileDomainsAPIClient added in v1.3.0 

type ListVoiceProfileDomainsAPIClient interface {
	ListVoiceProfileDomains(context.Context, *ListVoiceProfileDomainsInput, ...func(*Options)) (*ListVoiceProfileDomainsOutput, error)
}

ListVoiceProfileDomainsAPIClient is a client that implements the ListVoiceProfileDomains operation.

type ListVoiceProfileDomainsInput added in v1.3.0 

type ListVoiceProfileDomainsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVoiceProfileDomainsOutput added in v1.3.0 

type ListVoiceProfileDomainsOutput struct {

	// The token used to return the next page of results.
	NextToken *string

	// The list of voice profile domains.
	VoiceProfileDomains []types.VoiceProfileDomainSummary

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

type ListVoiceProfileDomainsPaginator added in v1.3.0 

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

ListVoiceProfileDomainsPaginator is a paginator for ListVoiceProfileDomains

func NewListVoiceProfileDomainsPaginator added in v1.3.0 

func NewListVoiceProfileDomainsPaginator(client ListVoiceProfileDomainsAPIClient, params *ListVoiceProfileDomainsInput, optFns ...func(*ListVoiceProfileDomainsPaginatorOptions)) *ListVoiceProfileDomainsPaginator

NewListVoiceProfileDomainsPaginator returns a new ListVoiceProfileDomainsPaginator

func (*ListVoiceProfileDomainsPaginator) HasMorePages added in v1.3.0 

func (p *ListVoiceProfileDomainsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVoiceProfileDomainsPaginator) NextPage added in v1.3.0 

func (p *ListVoiceProfileDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVoiceProfileDomainsOutput, error)

NextPage retrieves the next ListVoiceProfileDomains page.

type ListVoiceProfileDomainsPaginatorOptions added in v1.3.0 

type ListVoiceProfileDomainsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListVoiceProfileDomainsPaginatorOptions is the paginator options for ListVoiceProfileDomains

type ListVoiceProfilesAPIClient added in v1.3.0 

type ListVoiceProfilesAPIClient interface {
	ListVoiceProfiles(context.Context, *ListVoiceProfilesInput, ...func(*Options)) (*ListVoiceProfilesOutput, error)
}

ListVoiceProfilesAPIClient is a client that implements the ListVoiceProfiles operation.

type ListVoiceProfilesInput added in v1.3.0 

type ListVoiceProfilesInput struct {

	// The ID of the voice profile domain.
	//
	// This member is required.
	VoiceProfileDomainId *string

	// The maximum number of results in the request.
	MaxResults *int32

	// The token used to retrieve the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVoiceProfilesOutput added in v1.3.0 

type ListVoiceProfilesOutput struct {

	// The token used to retrieve the next page of results.
	NextToken *string

	// The list of voice profiles.
	VoiceProfiles []types.VoiceProfileSummary

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

type ListVoiceProfilesPaginator added in v1.3.0 

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

ListVoiceProfilesPaginator is a paginator for ListVoiceProfiles

func NewListVoiceProfilesPaginator added in v1.3.0 

func NewListVoiceProfilesPaginator(client ListVoiceProfilesAPIClient, params *ListVoiceProfilesInput, optFns ...func(*ListVoiceProfilesPaginatorOptions)) *ListVoiceProfilesPaginator

NewListVoiceProfilesPaginator returns a new ListVoiceProfilesPaginator

func (*ListVoiceProfilesPaginator) HasMorePages added in v1.3.0 

func (p *ListVoiceProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVoiceProfilesPaginator) NextPage added in v1.3.0 

func (p *ListVoiceProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVoiceProfilesOutput, error)

NextPage retrieves the next ListVoiceProfiles page.

type ListVoiceProfilesPaginatorOptions added in v1.3.0 

type ListVoiceProfilesPaginatorOptions struct {
	// The maximum number of results in the 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
}

ListVoiceProfilesPaginatorOptions is the paginator options for ListVoiceProfiles

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 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 added in v1.11.3 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutSipMediaApplicationAlexaSkillConfigurationInput 

type PutSipMediaApplicationAlexaSkillConfigurationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The Alexa Skill configuration.
	SipMediaApplicationAlexaSkillConfiguration *types.SipMediaApplicationAlexaSkillConfiguration
	// contains filtered or unexported fields
}

type PutSipMediaApplicationAlexaSkillConfigurationOutput 

type PutSipMediaApplicationAlexaSkillConfigurationOutput struct {

	// Returns the Alexa Skill configuration.
	SipMediaApplicationAlexaSkillConfiguration *types.SipMediaApplicationAlexaSkillConfiguration

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

type PutSipMediaApplicationLoggingConfigurationInput 

type PutSipMediaApplicationLoggingConfigurationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The logging configuration for the specified SIP media application.
	SipMediaApplicationLoggingConfiguration *types.SipMediaApplicationLoggingConfiguration
	// contains filtered or unexported fields
}

type PutSipMediaApplicationLoggingConfigurationOutput 

type PutSipMediaApplicationLoggingConfigurationOutput struct {

	// The updated logging configuration for the specified SIP media application.
	SipMediaApplicationLoggingConfiguration *types.SipMediaApplicationLoggingConfiguration

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

type PutVoiceConnectorEmergencyCallingConfigurationInput 

type PutVoiceConnectorEmergencyCallingConfigurationInput struct {

	// The configuration being updated.
	//
	// This member is required.
	EmergencyCallingConfiguration *types.EmergencyCallingConfiguration

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type PutVoiceConnectorEmergencyCallingConfigurationOutput 

type PutVoiceConnectorEmergencyCallingConfigurationOutput struct {

	// The updated configuration.
	EmergencyCallingConfiguration *types.EmergencyCallingConfiguration

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

type PutVoiceConnectorLoggingConfigurationInput 

type PutVoiceConnectorLoggingConfigurationInput struct {

	// The logging configuration being updated.
	//
	// This member is required.
	LoggingConfiguration *types.LoggingConfiguration

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type PutVoiceConnectorLoggingConfigurationOutput 

type PutVoiceConnectorLoggingConfigurationOutput struct {

	// The updated logging configuration.
	LoggingConfiguration *types.LoggingConfiguration

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

type PutVoiceConnectorOriginationInput 

type PutVoiceConnectorOriginationInput struct {

	// The origination settings being updated.
	//
	// This member is required.
	Origination *types.Origination

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type PutVoiceConnectorOriginationOutput 

type PutVoiceConnectorOriginationOutput struct {

	// The updated origination settings.
	Origination *types.Origination

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

type PutVoiceConnectorProxyInput 

type PutVoiceConnectorProxyInput struct {

	// The default number of minutes allowed for proxy session.
	//
	// This member is required.
	DefaultSessionExpiryMinutes *int32

	// The countries for proxy phone numbers to be selected from.
	//
	// This member is required.
	PhoneNumberPoolCountries []string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// When true, stops proxy sessions from being created on the specified Amazon
	// Chime SDK Voice Connector.
	Disabled *bool

	// The phone number to route calls to after a proxy session expires.
	FallBackPhoneNumber *string
	// contains filtered or unexported fields
}

type PutVoiceConnectorProxyOutput 

type PutVoiceConnectorProxyOutput struct {

	// The proxy configuration details.
	Proxy *types.Proxy

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

type PutVoiceConnectorStreamingConfigurationInput 

type PutVoiceConnectorStreamingConfigurationInput struct {

	// The streaming settings being updated.
	//
	// This member is required.
	StreamingConfiguration *types.StreamingConfiguration

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type PutVoiceConnectorStreamingConfigurationOutput 

type PutVoiceConnectorStreamingConfigurationOutput struct {

	// The updated streaming settings.
	StreamingConfiguration *types.StreamingConfiguration

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

type PutVoiceConnectorTerminationCredentialsInput 

type PutVoiceConnectorTerminationCredentialsInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The termination credentials being updated.
	Credentials []types.Credential
	// contains filtered or unexported fields
}

type PutVoiceConnectorTerminationCredentialsOutput 

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

type PutVoiceConnectorTerminationInput 

type PutVoiceConnectorTerminationInput struct {

	// The termination settings to be updated.
	//
	// This member is required.
	Termination *types.Termination

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type PutVoiceConnectorTerminationOutput 

type PutVoiceConnectorTerminationOutput struct {

	// The updated termination settings.
	Termination *types.Termination

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

type RestorePhoneNumberInput struct {

	// The ID of the phone number being restored.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type RestorePhoneNumberOutput 

type RestorePhoneNumberOutput struct {

	// The restored phone number.
	PhoneNumber *types.PhoneNumber

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

type SearchAvailablePhoneNumbersAPIClient 

type SearchAvailablePhoneNumbersAPIClient interface {
	SearchAvailablePhoneNumbers(context.Context, *SearchAvailablePhoneNumbersInput, ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)
}

SearchAvailablePhoneNumbersAPIClient is a client that implements the SearchAvailablePhoneNumbers operation.

type SearchAvailablePhoneNumbersInput 

type SearchAvailablePhoneNumbersInput struct {

	// Confines a search to just the phone numbers associated with the specified area
	// code.
	AreaCode *string

	// Confines a search to just the phone numbers associated with the specified city.
	City *string

	// Confines a search to just the phone numbers associated with the specified
	// country.
	Country *string

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

	// The token used to return the next page of results.
	NextToken *string

	// Confines a search to just the phone numbers associated with the specified phone
	// number type, either local or toll-free.
	PhoneNumberType types.PhoneNumberType

	// Confines a search to just the phone numbers associated with the specified state.
	State *string

	// Confines a search to just the phone numbers associated with the specified
	// toll-free prefix.
	TollFreePrefix *string
	// contains filtered or unexported fields
}

type SearchAvailablePhoneNumbersOutput 

type SearchAvailablePhoneNumbersOutput struct {

	// Confines a search to just the phone numbers in the E.164 format.
	E164PhoneNumbers []string

	// The token used to return the next page of results.
	NextToken *string

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

type SearchAvailablePhoneNumbersPaginator 

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

SearchAvailablePhoneNumbersPaginator is a paginator for SearchAvailablePhoneNumbers

func NewSearchAvailablePhoneNumbersPaginator 

func NewSearchAvailablePhoneNumbersPaginator(client SearchAvailablePhoneNumbersAPIClient, params *SearchAvailablePhoneNumbersInput, optFns ...func(*SearchAvailablePhoneNumbersPaginatorOptions)) *SearchAvailablePhoneNumbersPaginator

NewSearchAvailablePhoneNumbersPaginator returns a new SearchAvailablePhoneNumbersPaginator

func (*SearchAvailablePhoneNumbersPaginator) HasMorePages 

func (p *SearchAvailablePhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchAvailablePhoneNumbersPaginator) NextPage 

func (p *SearchAvailablePhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)

NextPage retrieves the next SearchAvailablePhoneNumbers page.

type SearchAvailablePhoneNumbersPaginatorOptions 

type SearchAvailablePhoneNumbersPaginatorOptions 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
}

SearchAvailablePhoneNumbersPaginatorOptions is the paginator options for SearchAvailablePhoneNumbers

type StartSpeakerSearchTaskInput added in v1.3.0 

type StartSpeakerSearchTaskInput struct {

	// The transaction ID of the call being analyzed.
	//
	// This member is required.
	TransactionId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The ID of the voice profile domain that will store the voice profile.
	//
	// This member is required.
	VoiceProfileDomainId *string

	// Specifies which call leg to stream for speaker search.
	CallLeg types.CallLegType

	// The unique identifier for the client request. Use a different token for
	// different speaker search tasks.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type StartSpeakerSearchTaskOutput added in v1.3.0 

type StartSpeakerSearchTaskOutput struct {

	// The details of the speaker search task.
	SpeakerSearchTask *types.SpeakerSearchTask

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

type StartVoiceToneAnalysisTaskInput added in v1.3.0 

type StartVoiceToneAnalysisTaskInput struct {

	// The language code.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The transaction ID.
	//
	// This member is required.
	TransactionId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The unique identifier for the client request. Use a different token for
	// different voice tone analysis tasks.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type StartVoiceToneAnalysisTaskOutput added in v1.3.0 

type StartVoiceToneAnalysisTaskOutput struct {

	// The details of the voice tone analysis task.
	VoiceToneAnalysisTask *types.VoiceToneAnalysisTask

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

type StopSpeakerSearchTaskInput added in v1.3.0 

type StopSpeakerSearchTaskInput struct {

	// The speaker search task ID.
	//
	// This member is required.
	SpeakerSearchTaskId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type StopSpeakerSearchTaskOutput added in v1.3.0 

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

type StopVoiceToneAnalysisTaskInput added in v1.3.0 

type StopVoiceToneAnalysisTaskInput struct {

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The ID of the voice tone analysis task.
	//
	// This member is required.
	VoiceToneAnalysisTaskId *string
	// contains filtered or unexported fields
}

type StopVoiceToneAnalysisTaskOutput added in v1.3.0 

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

type TagResourceInput added in v1.3.0 

type TagResourceInput struct {

	// The ARN of the resource being tagged.
	//
	// This member is required.
	ResourceARN *string

	// A list of the tags being added to the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.3.0 

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

type UntagResourceInput added in v1.3.0 

type UntagResourceInput struct {

	// The ARN of the resource having its tags removed.
	//
	// This member is required.
	ResourceARN *string

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

type UntagResourceOutput added in v1.3.0 

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

type UpdateGlobalSettingsInput 

type UpdateGlobalSettingsInput struct {

	// The Voice Connector settings.
	VoiceConnector *types.VoiceConnectorSettings
	// contains filtered or unexported fields
}

type UpdateGlobalSettingsOutput 

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

type UpdatePhoneNumberInput 

type UpdatePhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string

	// The outbound calling name associated with the phone number.
	CallingName *string

	// Specifies the name assigned to one or more phone numbers.
	Name *string

	// The product type.
	ProductType types.PhoneNumberProductType
	// contains filtered or unexported fields
}

type UpdatePhoneNumberOutput 

type UpdatePhoneNumberOutput struct {

	// The updated phone number details.
	PhoneNumber *types.PhoneNumber

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

type UpdatePhoneNumberSettingsInput 

type UpdatePhoneNumberSettingsInput struct {

	// The default outbound calling name for the account.
	//
	// This member is required.
	CallingName *string
	// contains filtered or unexported fields
}

type UpdatePhoneNumberSettingsOutput 

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

type UpdateProxySessionInput 

type UpdateProxySessionInput struct {

	// The proxy session capabilities.
	//
	// This member is required.
	Capabilities []types.Capability

	// The proxy session ID.
	//
	// This member is required.
	ProxySessionId *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The number of minutes allowed for the proxy session.
	ExpiryMinutes *int32
	// contains filtered or unexported fields
}

type UpdateProxySessionOutput 

type UpdateProxySessionOutput struct {

	// The updated proxy session details.
	ProxySession *types.ProxySession

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

type UpdateSipMediaApplicationCallInput 

type UpdateSipMediaApplicationCallInput struct {

	// Arguments made available to the Lambda function as part of the
	// CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.
	//
	// This member is required.
	Arguments map[string]string

	// The ID of the SIP media application handling the call.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The ID of the call transaction.
	//
	// This member is required.
	TransactionId *string
	// contains filtered or unexported fields
}

type UpdateSipMediaApplicationCallOutput 

type UpdateSipMediaApplicationCallOutput struct {

	// A Call instance for a SIP media application.
	SipMediaApplicationCall *types.SipMediaApplicationCall

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

type UpdateSipMediaApplicationInput 

type UpdateSipMediaApplicationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The new set of endpoints for the specified SIP media application.
	Endpoints []types.SipMediaApplicationEndpoint

	// The new name for the specified SIP media application.
	Name *string
	// contains filtered or unexported fields
}

type UpdateSipMediaApplicationOutput 

type UpdateSipMediaApplicationOutput struct {

	// The updated SIP media application’s details.
	SipMediaApplication *types.SipMediaApplication

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

type UpdateSipRuleInput 

type UpdateSipRuleInput struct {

	// The new name for the specified SIP rule.
	//
	// This member is required.
	Name *string

	// The SIP rule ID.
	//
	// This member is required.
	SipRuleId *string

	// The new value that indicates whether the rule is disabled.
	Disabled *bool

	// The new list of target applications.
	TargetApplications []types.SipRuleTargetApplication
	// contains filtered or unexported fields
}

type UpdateSipRuleOutput 

type UpdateSipRuleOutput struct {

	// The updated SIP rule details.
	SipRule *types.SipRule

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

type UpdateVoiceConnectorGroupInput 

type UpdateVoiceConnectorGroupInput struct {

	// The name of the Voice Connector group.
	//
	// This member is required.
	Name *string

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string

	// The VoiceConnectorItems to associate with the Voice Connector group.
	//
	// This member is required.
	VoiceConnectorItems []types.VoiceConnectorItem
	// contains filtered or unexported fields
}

type UpdateVoiceConnectorGroupOutput 

type UpdateVoiceConnectorGroupOutput struct {

	// The updated Voice Connector group.
	VoiceConnectorGroup *types.VoiceConnectorGroup

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

type UpdateVoiceConnectorInput 

type UpdateVoiceConnectorInput struct {

	// The name of the Voice Connector.
	//
	// This member is required.
	Name *string

	// When enabled, requires encryption for the Voice Connector.
	//
	// This member is required.
	RequireEncryption *bool

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

type UpdateVoiceConnectorOutput 

type UpdateVoiceConnectorOutput struct {

	// The updated Voice Connector details.
	VoiceConnector *types.VoiceConnector

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

type UpdateVoiceProfileDomainInput added in v1.3.0 

type UpdateVoiceProfileDomainInput struct {

	// The domain ID.
	//
	// This member is required.
	VoiceProfileDomainId *string

	// The description of the voice profile domain.
	Description *string

	// The name of the voice profile domain.
	Name *string
	// contains filtered or unexported fields
}

type UpdateVoiceProfileDomainOutput added in v1.3.0 

type UpdateVoiceProfileDomainOutput struct {

	// The updated details of the voice profile domain.
	VoiceProfileDomain *types.VoiceProfileDomain

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

type UpdateVoiceProfileInput added in v1.3.0 

type UpdateVoiceProfileInput struct {

	// The ID of the speaker search task.
	//
	// This member is required.
	SpeakerSearchTaskId *string

	// The profile ID.
	//
	// This member is required.
	VoiceProfileId *string
	// contains filtered or unexported fields
}

type UpdateVoiceProfileOutput added in v1.3.0 

type UpdateVoiceProfileOutput struct {

	// The updated voice profile settings.
	VoiceProfile *types.VoiceProfile

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

type ValidateE911AddressInput 

type ValidateE911AddressInput struct {

	// The AWS account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The address city, such as Portland .
	//
	// This member is required.
	City *string

	// The country in the address being validated.
	//
	// This member is required.
	Country *string

	// The dress postal code, such 04352 .
	//
	// This member is required.
	PostalCode *string

	// The address state, such as ME .
	//
	// This member is required.
	State *string

	// The address street information, such as 8th Avenue .
	//
	// This member is required.
	StreetInfo *string

	// The address street number, such as 200 or 2121 .
	//
	// This member is required.
	StreetNumber *string
	// contains filtered or unexported fields
}

type ValidateE911AddressOutput 

type ValidateE911AddressOutput struct {

	// The validated address.
	Address *types.Address

	// The ID that represents the address.
	AddressExternalId *string

	// The list of address suggestions..
	CandidateAddressList []types.CandidateAddress

	// Number indicating the result of address validation. 0 means the address was
	// perfect as-is and successfully validated. 1 means the address was corrected. 2
	// means the address sent was not close enough and was not validated.
	ValidationResult 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.