chimesdkidentity

package
v1.42.28 Latest Latest
Warning

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

Go to latest
Published: Jan 5, 2022 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package chimesdkidentity provides the client and types for making API requests to Amazon Chime SDK Identity.

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html).

See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20 for more information on this service.

See chimesdkidentity package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkidentity/

Using the Client

To contact Amazon Chime SDK Identity with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Chime SDK Identity client ChimeSDKIdentity for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkidentity/#New

Index

Constants

View Source
const (
	// AllowMessagesAll is a AllowMessages enum value
	AllowMessagesAll = "ALL"

	// AllowMessagesNone is a AllowMessages enum value
	AllowMessagesNone = "NONE"
)
View Source
const (
	// AppInstanceUserEndpointTypeApns is a AppInstanceUserEndpointType enum value
	AppInstanceUserEndpointTypeApns = "APNS"

	// AppInstanceUserEndpointTypeApnsSandbox is a AppInstanceUserEndpointType enum value
	AppInstanceUserEndpointTypeApnsSandbox = "APNS_SANDBOX"

	// AppInstanceUserEndpointTypeGcm is a AppInstanceUserEndpointType enum value
	AppInstanceUserEndpointTypeGcm = "GCM"
)
View Source
const (
	// EndpointStatusActive is a EndpointStatus enum value
	EndpointStatusActive = "ACTIVE"

	// EndpointStatusInactive is a EndpointStatus enum value
	EndpointStatusInactive = "INACTIVE"
)
View Source
const (
	// EndpointStatusReasonInvalidDeviceToken is a EndpointStatusReason enum value
	EndpointStatusReasonInvalidDeviceToken = "INVALID_DEVICE_TOKEN"

	// EndpointStatusReasonInvalidPinpointArn is a EndpointStatusReason enum value
	EndpointStatusReasonInvalidPinpointArn = "INVALID_PINPOINT_ARN"
)
View Source
const (
	// ErrorCodeBadRequest is a ErrorCode enum value
	ErrorCodeBadRequest = "BadRequest"

	// ErrorCodeConflict is a ErrorCode enum value
	ErrorCodeConflict = "Conflict"

	// ErrorCodeForbidden is a ErrorCode enum value
	ErrorCodeForbidden = "Forbidden"

	// ErrorCodeNotFound is a ErrorCode enum value
	ErrorCodeNotFound = "NotFound"

	// ErrorCodePreconditionFailed is a ErrorCode enum value
	ErrorCodePreconditionFailed = "PreconditionFailed"

	// ErrorCodeResourceLimitExceeded is a ErrorCode enum value
	ErrorCodeResourceLimitExceeded = "ResourceLimitExceeded"

	// ErrorCodeServiceFailure is a ErrorCode enum value
	ErrorCodeServiceFailure = "ServiceFailure"

	// ErrorCodeAccessDenied is a ErrorCode enum value
	ErrorCodeAccessDenied = "AccessDenied"

	// ErrorCodeServiceUnavailable is a ErrorCode enum value
	ErrorCodeServiceUnavailable = "ServiceUnavailable"

	// ErrorCodeThrottled is a ErrorCode enum value
	ErrorCodeThrottled = "Throttled"

	// ErrorCodeThrottling is a ErrorCode enum value
	ErrorCodeThrottling = "Throttling"

	// ErrorCodeUnauthorized is a ErrorCode enum value
	ErrorCodeUnauthorized = "Unauthorized"

	// ErrorCodeUnprocessable is a ErrorCode enum value
	ErrorCodeUnprocessable = "Unprocessable"

	// ErrorCodeVoiceConnectorGroupAssociationsExist is a ErrorCode enum value
	ErrorCodeVoiceConnectorGroupAssociationsExist = "VoiceConnectorGroupAssociationsExist"

	// ErrorCodePhoneNumberAssociationsExist is a ErrorCode enum value
	ErrorCodePhoneNumberAssociationsExist = "PhoneNumberAssociationsExist"
)
View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The input parameters don't match the service's restrictions.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request could not be processed because of conflict in the current state
	// of the resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// The client is permanently forbidden from making the request.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// The request exceeds the resource limit.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeServiceFailureException for service response error code
	// "ServiceFailureException".
	//
	// The service encountered an unexpected error.
	ErrCodeServiceFailureException = "ServiceFailureException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is currently unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottledClientException for service response error code
	// "ThrottledClientException".
	//
	// The client exceeded its request rate limit.
	ErrCodeThrottledClientException = "ThrottledClientException"

	// ErrCodeUnauthorizedClientException for service response error code
	// "UnauthorizedClientException".
	//
	// The client is not currently authorized to make the request.
	ErrCodeUnauthorizedClientException = "UnauthorizedClientException"
)
View Source
const (
	ServiceName = "Chime SDK Identity" // Name of service.
	EndpointsID = "identity-chime"     // ID to lookup a service endpoint with.
	ServiceID   = "Chime SDK Identity" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AllowMessages_Values added in v1.41.11

func AllowMessages_Values() []string

AllowMessages_Values returns all elements of the AllowMessages enum

func AppInstanceUserEndpointType_Values added in v1.41.11

func AppInstanceUserEndpointType_Values() []string

AppInstanceUserEndpointType_Values returns all elements of the AppInstanceUserEndpointType enum

func EndpointStatusReason_Values added in v1.41.11

func EndpointStatusReason_Values() []string

EndpointStatusReason_Values returns all elements of the EndpointStatusReason enum

func EndpointStatus_Values added in v1.41.11

func EndpointStatus_Values() []string

EndpointStatus_Values returns all elements of the EndpointStatus enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

Types

type AppInstance

type AppInstance struct {

	// The ARN of the messaging instance.
	AppInstanceArn *string `min:"5" type:"string"`

	// The time at which an AppInstance was created. In epoch milliseconds.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The time an AppInstance was last updated. In epoch milliseconds.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The metadata of an AppInstance.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstance's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The name of an AppInstance.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstance's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

func (AppInstance) GoString

func (s AppInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstance) SetAppInstanceArn

func (s *AppInstance) SetAppInstanceArn(v string) *AppInstance

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*AppInstance) SetCreatedTimestamp

func (s *AppInstance) SetCreatedTimestamp(v time.Time) *AppInstance

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*AppInstance) SetLastUpdatedTimestamp

func (s *AppInstance) SetLastUpdatedTimestamp(v time.Time) *AppInstance

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*AppInstance) SetMetadata

func (s *AppInstance) SetMetadata(v string) *AppInstance

SetMetadata sets the Metadata field's value.

func (*AppInstance) SetName

func (s *AppInstance) SetName(v string) *AppInstance

SetName sets the Name field's value.

func (AppInstance) String

func (s AppInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceAdmin

type AppInstanceAdmin struct {

	// The AppInstanceAdmin data.
	Admin *Identity `type:"structure"`

	// The ARN of the AppInstance for which the user is an administrator.
	AppInstanceArn *string `min:"5" type:"string"`

	// The time at which an administrator was created.
	CreatedTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The details of an AppInstanceAdmin.

func (AppInstanceAdmin) GoString

func (s AppInstanceAdmin) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceAdmin) SetAdmin

func (s *AppInstanceAdmin) SetAdmin(v *Identity) *AppInstanceAdmin

SetAdmin sets the Admin field's value.

func (*AppInstanceAdmin) SetAppInstanceArn

func (s *AppInstanceAdmin) SetAppInstanceArn(v string) *AppInstanceAdmin

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*AppInstanceAdmin) SetCreatedTimestamp

func (s *AppInstanceAdmin) SetCreatedTimestamp(v time.Time) *AppInstanceAdmin

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (AppInstanceAdmin) String

func (s AppInstanceAdmin) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceAdminSummary

type AppInstanceAdminSummary struct {

	// The details of the AppInstanceAdmin.
	Admin *Identity `type:"structure"`
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceAdmin.

func (AppInstanceAdminSummary) GoString

func (s AppInstanceAdminSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceAdminSummary) SetAdmin

SetAdmin sets the Admin field's value.

func (AppInstanceAdminSummary) String

func (s AppInstanceAdminSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceRetentionSettings

type AppInstanceRetentionSettings struct {

	// The length of time in days to retain the messages in a channel.
	ChannelRetentionSettings *ChannelRetentionSettings `type:"structure"`
	// contains filtered or unexported fields
}

The details of the data-retention settings for an AppInstance.

func (AppInstanceRetentionSettings) GoString

func (s AppInstanceRetentionSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceRetentionSettings) SetChannelRetentionSettings

SetChannelRetentionSettings sets the ChannelRetentionSettings field's value.

func (AppInstanceRetentionSettings) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceRetentionSettings) Validate

func (s *AppInstanceRetentionSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AppInstanceSummary

type AppInstanceSummary struct {

	// The AppInstance ARN.
	AppInstanceArn *string `min:"5" type:"string"`

	// The metadata of the AppInstance.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceSummary's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The name of the AppInstance.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Summary of the data for an AppInstance.

func (AppInstanceSummary) GoString

func (s AppInstanceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceSummary) SetAppInstanceArn

func (s *AppInstanceSummary) SetAppInstanceArn(v string) *AppInstanceSummary

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*AppInstanceSummary) SetMetadata

func (s *AppInstanceSummary) SetMetadata(v string) *AppInstanceSummary

SetMetadata sets the Metadata field's value.

func (*AppInstanceSummary) SetName

SetName sets the Name field's value.

func (AppInstanceSummary) String

func (s AppInstanceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceUser

type AppInstanceUser struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string `min:"5" type:"string"`

	// The time at which the AppInstanceUser was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The time at which the AppInstanceUser was last updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The metadata of the AppInstanceUser.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUser's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The name of the AppInstanceUser.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUser's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of an AppInstanceUser.

func (AppInstanceUser) GoString

func (s AppInstanceUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceUser) SetAppInstanceUserArn

func (s *AppInstanceUser) SetAppInstanceUserArn(v string) *AppInstanceUser

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*AppInstanceUser) SetCreatedTimestamp

func (s *AppInstanceUser) SetCreatedTimestamp(v time.Time) *AppInstanceUser

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*AppInstanceUser) SetLastUpdatedTimestamp

func (s *AppInstanceUser) SetLastUpdatedTimestamp(v time.Time) *AppInstanceUser

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*AppInstanceUser) SetMetadata

func (s *AppInstanceUser) SetMetadata(v string) *AppInstanceUser

SetMetadata sets the Metadata field's value.

func (*AppInstanceUser) SetName

func (s *AppInstanceUser) SetName(v string) *AppInstanceUser

SetName sets the Name field's value.

func (AppInstanceUser) String

func (s AppInstanceUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceUserEndpoint added in v1.41.11

type AppInstanceUserEndpoint struct {

	// Boolean that controls whether the AppInstanceUserEndpoint is opted in to
	// receive messages. ALL indicates the endpoint will receive all messages. NONE
	// indicates the endpoint will receive no messages.
	AllowMessages *string `type:"string" enum:"AllowMessages"`

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpoint's
	// String and GoString methods.
	AppInstanceUserArn *string `min:"5" type:"string" sensitive:"true"`

	// The time at which an AppInstanceUserEndpoint was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The attributes of an Endpoint.
	EndpointAttributes *EndpointAttributes `type:"structure"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpoint's
	// String and GoString methods.
	EndpointId *string `type:"string" sensitive:"true"`

	// A read-only field that represents the state of an AppInstanceUserEndpoint.
	// Supported values:
	//
	//    * ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages.
	//    When ACTIVE, the EndpointStatusReason remains empty.
	//
	//    * INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive
	//    message. When INACTIVE, the corresponding reason will be conveyed through
	//    EndpointStatusReason.
	//
	//    * INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE
	//    due to invalid device token
	//
	//    * INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE
	//    due to an invalid pinpoint ARN that was input through the ResourceArn
	//    field.
	EndpointState *EndpointState `type:"structure"`

	// The time at which an AppInstanceUserEndpoint was last updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp"`

	// The name of the AppInstanceUserEndpoint.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpoint's
	// String and GoString methods.
	Name *string `type:"string" sensitive:"true"`

	// The ARN of the resource to which the endpoint belongs.
	//
	// ResourceArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpoint's
	// String and GoString methods.
	ResourceArn *string `min:"5" type:"string" sensitive:"true"`

	// The type of the AppInstanceUserEndpoint.
	Type *string `type:"string" enum:"AppInstanceUserEndpointType"`
	// contains filtered or unexported fields
}

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

func (AppInstanceUserEndpoint) GoString added in v1.41.11

func (s AppInstanceUserEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceUserEndpoint) SetAllowMessages added in v1.41.11

func (s *AppInstanceUserEndpoint) SetAllowMessages(v string) *AppInstanceUserEndpoint

SetAllowMessages sets the AllowMessages field's value.

func (*AppInstanceUserEndpoint) SetAppInstanceUserArn added in v1.41.11

func (s *AppInstanceUserEndpoint) SetAppInstanceUserArn(v string) *AppInstanceUserEndpoint

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*AppInstanceUserEndpoint) SetCreatedTimestamp added in v1.41.11

func (s *AppInstanceUserEndpoint) SetCreatedTimestamp(v time.Time) *AppInstanceUserEndpoint

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*AppInstanceUserEndpoint) SetEndpointAttributes added in v1.41.11

SetEndpointAttributes sets the EndpointAttributes field's value.

func (*AppInstanceUserEndpoint) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (*AppInstanceUserEndpoint) SetEndpointState added in v1.41.11

SetEndpointState sets the EndpointState field's value.

func (*AppInstanceUserEndpoint) SetLastUpdatedTimestamp added in v1.41.11

func (s *AppInstanceUserEndpoint) SetLastUpdatedTimestamp(v time.Time) *AppInstanceUserEndpoint

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*AppInstanceUserEndpoint) SetName added in v1.41.11

SetName sets the Name field's value.

func (*AppInstanceUserEndpoint) SetResourceArn added in v1.41.11

SetResourceArn sets the ResourceArn field's value.

func (*AppInstanceUserEndpoint) SetType added in v1.41.11

SetType sets the Type field's value.

func (AppInstanceUserEndpoint) String added in v1.41.11

func (s AppInstanceUserEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceUserEndpointSummary added in v1.41.11

type AppInstanceUserEndpointSummary struct {

	// BBoolean that controls whether the AppInstanceUserEndpoint is opted in to
	// receive messages. ALL indicates the endpoint will receive all messages. NONE
	// indicates the endpoint will receive no messages.
	AllowMessages *string `type:"string" enum:"AllowMessages"`

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpointSummary's
	// String and GoString methods.
	AppInstanceUserArn *string `min:"5" type:"string" sensitive:"true"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpointSummary's
	// String and GoString methods.
	EndpointId *string `type:"string" sensitive:"true"`

	// A read-only field that represent the state of an AppInstanceUserEndpoint.
	EndpointState *EndpointState `type:"structure"`

	// The name of the AppInstanceUserEndpoint.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserEndpointSummary's
	// String and GoString methods.
	Name *string `type:"string" sensitive:"true"`

	// The type of the AppInstanceUserEndpoint.
	Type *string `type:"string" enum:"AppInstanceUserEndpointType"`
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceUserEndpoint.

func (AppInstanceUserEndpointSummary) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceUserEndpointSummary) SetAllowMessages added in v1.41.11

SetAllowMessages sets the AllowMessages field's value.

func (*AppInstanceUserEndpointSummary) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*AppInstanceUserEndpointSummary) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (*AppInstanceUserEndpointSummary) SetEndpointState added in v1.41.11

SetEndpointState sets the EndpointState field's value.

func (*AppInstanceUserEndpointSummary) SetName added in v1.41.11

SetName sets the Name field's value.

func (*AppInstanceUserEndpointSummary) SetType added in v1.41.11

SetType sets the Type field's value.

func (AppInstanceUserEndpointSummary) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppInstanceUserSummary

type AppInstanceUserSummary struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string `min:"5" type:"string"`

	// The metadata of the AppInstanceUser.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserSummary's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The name of an AppInstanceUser.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AppInstanceUserSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceUser.

func (AppInstanceUserSummary) GoString

func (s AppInstanceUserSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppInstanceUserSummary) SetAppInstanceUserArn

func (s *AppInstanceUserSummary) SetAppInstanceUserArn(v string) *AppInstanceUserSummary

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*AppInstanceUserSummary) SetMetadata

SetMetadata sets the Metadata field's value.

func (*AppInstanceUserSummary) SetName

SetName sets the Name field's value.

func (AppInstanceUserSummary) String

func (s AppInstanceUserSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequestException

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The input parameters don't match the service's restrictions.

func (*BadRequestException) Code

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error

func (s *BadRequestException) Error() string

func (BadRequestException) GoString

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelRetentionSettings

type ChannelRetentionSettings struct {

	// The time in days to retain the messages in a channel.
	RetentionDays *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The details of the retention settings for a channel.

func (ChannelRetentionSettings) GoString

func (s ChannelRetentionSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelRetentionSettings) SetRetentionDays

SetRetentionDays sets the RetentionDays field's value.

func (ChannelRetentionSettings) String

func (s ChannelRetentionSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelRetentionSettings) Validate

func (s *ChannelRetentionSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ChimeSDKIdentity

type ChimeSDKIdentity struct {
	*client.Client
}

ChimeSDKIdentity provides the API operation methods for making requests to Amazon Chime SDK Identity. See this package's package overview docs for details on the service.

ChimeSDKIdentity methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the ChimeSDKIdentity client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a ChimeSDKIdentity client from just a session.
svc := chimesdkidentity.New(mySession)

// Create a ChimeSDKIdentity client with additional configuration
svc := chimesdkidentity.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ChimeSDKIdentity) CreateAppInstance

func (c *ChimeSDKIdentity) CreateAppInstance(input *CreateAppInstanceInput) (*CreateAppInstanceOutput, error)

CreateAppInstance API operation for Amazon Chime SDK Identity.

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation CreateAppInstance for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstance

func (*ChimeSDKIdentity) CreateAppInstanceAdmin

CreateAppInstanceAdmin API operation for Amazon Chime SDK Identity.

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation CreateAppInstanceAdmin for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceAdmin

func (*ChimeSDKIdentity) CreateAppInstanceAdminRequest

func (c *ChimeSDKIdentity) CreateAppInstanceAdminRequest(input *CreateAppInstanceAdminInput) (req *request.Request, output *CreateAppInstanceAdminOutput)

CreateAppInstanceAdminRequest generates a "aws/request.Request" representing the client's request for the CreateAppInstanceAdmin operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAppInstanceAdmin for more information on using the CreateAppInstanceAdmin API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAppInstanceAdminRequest method.
req, resp := client.CreateAppInstanceAdminRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceAdmin

func (*ChimeSDKIdentity) CreateAppInstanceAdminWithContext

func (c *ChimeSDKIdentity) CreateAppInstanceAdminWithContext(ctx aws.Context, input *CreateAppInstanceAdminInput, opts ...request.Option) (*CreateAppInstanceAdminOutput, error)

CreateAppInstanceAdminWithContext is the same as CreateAppInstanceAdmin with the addition of the ability to pass a context and additional request options.

See CreateAppInstanceAdmin for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) CreateAppInstanceRequest

func (c *ChimeSDKIdentity) CreateAppInstanceRequest(input *CreateAppInstanceInput) (req *request.Request, output *CreateAppInstanceOutput)

CreateAppInstanceRequest generates a "aws/request.Request" representing the client's request for the CreateAppInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAppInstance for more information on using the CreateAppInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAppInstanceRequest method.
req, resp := client.CreateAppInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstance

func (*ChimeSDKIdentity) CreateAppInstanceUser

CreateAppInstanceUser API operation for Amazon Chime SDK Identity.

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation CreateAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceUser

func (*ChimeSDKIdentity) CreateAppInstanceUserRequest

func (c *ChimeSDKIdentity) CreateAppInstanceUserRequest(input *CreateAppInstanceUserInput) (req *request.Request, output *CreateAppInstanceUserOutput)

CreateAppInstanceUserRequest generates a "aws/request.Request" representing the client's request for the CreateAppInstanceUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAppInstanceUser for more information on using the CreateAppInstanceUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAppInstanceUserRequest method.
req, resp := client.CreateAppInstanceUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceUser

func (*ChimeSDKIdentity) CreateAppInstanceUserWithContext

func (c *ChimeSDKIdentity) CreateAppInstanceUserWithContext(ctx aws.Context, input *CreateAppInstanceUserInput, opts ...request.Option) (*CreateAppInstanceUserOutput, error)

CreateAppInstanceUserWithContext is the same as CreateAppInstanceUser with the addition of the ability to pass a context and additional request options.

See CreateAppInstanceUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) CreateAppInstanceWithContext

func (c *ChimeSDKIdentity) CreateAppInstanceWithContext(ctx aws.Context, input *CreateAppInstanceInput, opts ...request.Option) (*CreateAppInstanceOutput, error)

CreateAppInstanceWithContext is the same as CreateAppInstance with the addition of the ability to pass a context and additional request options.

See CreateAppInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DeleteAppInstance

func (c *ChimeSDKIdentity) DeleteAppInstance(input *DeleteAppInstanceInput) (*DeleteAppInstanceOutput, error)

DeleteAppInstance API operation for Amazon Chime SDK Identity.

Deletes an AppInstance and all associated data asynchronously.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DeleteAppInstance for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstance

func (*ChimeSDKIdentity) DeleteAppInstanceAdmin

DeleteAppInstanceAdmin API operation for Amazon Chime SDK Identity.

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DeleteAppInstanceAdmin for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceAdmin

func (*ChimeSDKIdentity) DeleteAppInstanceAdminRequest

func (c *ChimeSDKIdentity) DeleteAppInstanceAdminRequest(input *DeleteAppInstanceAdminInput) (req *request.Request, output *DeleteAppInstanceAdminOutput)

DeleteAppInstanceAdminRequest generates a "aws/request.Request" representing the client's request for the DeleteAppInstanceAdmin operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAppInstanceAdmin for more information on using the DeleteAppInstanceAdmin API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAppInstanceAdminRequest method.
req, resp := client.DeleteAppInstanceAdminRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceAdmin

func (*ChimeSDKIdentity) DeleteAppInstanceAdminWithContext

func (c *ChimeSDKIdentity) DeleteAppInstanceAdminWithContext(ctx aws.Context, input *DeleteAppInstanceAdminInput, opts ...request.Option) (*DeleteAppInstanceAdminOutput, error)

DeleteAppInstanceAdminWithContext is the same as DeleteAppInstanceAdmin with the addition of the ability to pass a context and additional request options.

See DeleteAppInstanceAdmin for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DeleteAppInstanceRequest

func (c *ChimeSDKIdentity) DeleteAppInstanceRequest(input *DeleteAppInstanceInput) (req *request.Request, output *DeleteAppInstanceOutput)

DeleteAppInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteAppInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAppInstance for more information on using the DeleteAppInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAppInstanceRequest method.
req, resp := client.DeleteAppInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstance

func (*ChimeSDKIdentity) DeleteAppInstanceUser

DeleteAppInstanceUser API operation for Amazon Chime SDK Identity.

Deletes an AppInstanceUser.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DeleteAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceUser

func (*ChimeSDKIdentity) DeleteAppInstanceUserRequest

func (c *ChimeSDKIdentity) DeleteAppInstanceUserRequest(input *DeleteAppInstanceUserInput) (req *request.Request, output *DeleteAppInstanceUserOutput)

DeleteAppInstanceUserRequest generates a "aws/request.Request" representing the client's request for the DeleteAppInstanceUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAppInstanceUser for more information on using the DeleteAppInstanceUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAppInstanceUserRequest method.
req, resp := client.DeleteAppInstanceUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceUser

func (*ChimeSDKIdentity) DeleteAppInstanceUserWithContext

func (c *ChimeSDKIdentity) DeleteAppInstanceUserWithContext(ctx aws.Context, input *DeleteAppInstanceUserInput, opts ...request.Option) (*DeleteAppInstanceUserOutput, error)

DeleteAppInstanceUserWithContext is the same as DeleteAppInstanceUser with the addition of the ability to pass a context and additional request options.

See DeleteAppInstanceUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DeleteAppInstanceWithContext

func (c *ChimeSDKIdentity) DeleteAppInstanceWithContext(ctx aws.Context, input *DeleteAppInstanceInput, opts ...request.Option) (*DeleteAppInstanceOutput, error)

DeleteAppInstanceWithContext is the same as DeleteAppInstance with the addition of the ability to pass a context and additional request options.

See DeleteAppInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DeregisterAppInstanceUserEndpoint added in v1.41.11

DeregisterAppInstanceUserEndpoint API operation for Amazon Chime SDK Identity.

Deregisters an AppInstanceUserEndpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DeregisterAppInstanceUserEndpoint for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeregisterAppInstanceUserEndpoint

func (*ChimeSDKIdentity) DeregisterAppInstanceUserEndpointRequest added in v1.41.11

func (c *ChimeSDKIdentity) DeregisterAppInstanceUserEndpointRequest(input *DeregisterAppInstanceUserEndpointInput) (req *request.Request, output *DeregisterAppInstanceUserEndpointOutput)

DeregisterAppInstanceUserEndpointRequest generates a "aws/request.Request" representing the client's request for the DeregisterAppInstanceUserEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterAppInstanceUserEndpoint for more information on using the DeregisterAppInstanceUserEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterAppInstanceUserEndpointRequest method.
req, resp := client.DeregisterAppInstanceUserEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeregisterAppInstanceUserEndpoint

func (*ChimeSDKIdentity) DeregisterAppInstanceUserEndpointWithContext added in v1.41.11

func (c *ChimeSDKIdentity) DeregisterAppInstanceUserEndpointWithContext(ctx aws.Context, input *DeregisterAppInstanceUserEndpointInput, opts ...request.Option) (*DeregisterAppInstanceUserEndpointOutput, error)

DeregisterAppInstanceUserEndpointWithContext is the same as DeregisterAppInstanceUserEndpoint with the addition of the ability to pass a context and additional request options.

See DeregisterAppInstanceUserEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DescribeAppInstance

func (c *ChimeSDKIdentity) DescribeAppInstance(input *DescribeAppInstanceInput) (*DescribeAppInstanceOutput, error)

DescribeAppInstance API operation for Amazon Chime SDK Identity.

Returns the full details of an AppInstance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DescribeAppInstance for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstance

func (*ChimeSDKIdentity) DescribeAppInstanceAdmin

DescribeAppInstanceAdmin API operation for Amazon Chime SDK Identity.

Returns the full details of an AppInstanceAdmin.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DescribeAppInstanceAdmin for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceAdmin

func (*ChimeSDKIdentity) DescribeAppInstanceAdminRequest

func (c *ChimeSDKIdentity) DescribeAppInstanceAdminRequest(input *DescribeAppInstanceAdminInput) (req *request.Request, output *DescribeAppInstanceAdminOutput)

DescribeAppInstanceAdminRequest generates a "aws/request.Request" representing the client's request for the DescribeAppInstanceAdmin operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAppInstanceAdmin for more information on using the DescribeAppInstanceAdmin API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAppInstanceAdminRequest method.
req, resp := client.DescribeAppInstanceAdminRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceAdmin

func (*ChimeSDKIdentity) DescribeAppInstanceAdminWithContext

func (c *ChimeSDKIdentity) DescribeAppInstanceAdminWithContext(ctx aws.Context, input *DescribeAppInstanceAdminInput, opts ...request.Option) (*DescribeAppInstanceAdminOutput, error)

DescribeAppInstanceAdminWithContext is the same as DescribeAppInstanceAdmin with the addition of the ability to pass a context and additional request options.

See DescribeAppInstanceAdmin for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DescribeAppInstanceRequest

func (c *ChimeSDKIdentity) DescribeAppInstanceRequest(input *DescribeAppInstanceInput) (req *request.Request, output *DescribeAppInstanceOutput)

DescribeAppInstanceRequest generates a "aws/request.Request" representing the client's request for the DescribeAppInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAppInstance for more information on using the DescribeAppInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAppInstanceRequest method.
req, resp := client.DescribeAppInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstance

func (*ChimeSDKIdentity) DescribeAppInstanceUser

DescribeAppInstanceUser API operation for Amazon Chime SDK Identity.

Returns the full details of an AppInstanceUser.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DescribeAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceUser

func (*ChimeSDKIdentity) DescribeAppInstanceUserEndpoint added in v1.41.11

DescribeAppInstanceUserEndpoint API operation for Amazon Chime SDK Identity.

Returns the full details of an AppInstanceUserEndpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation DescribeAppInstanceUserEndpoint for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceUserEndpoint

func (*ChimeSDKIdentity) DescribeAppInstanceUserEndpointRequest added in v1.41.11

func (c *ChimeSDKIdentity) DescribeAppInstanceUserEndpointRequest(input *DescribeAppInstanceUserEndpointInput) (req *request.Request, output *DescribeAppInstanceUserEndpointOutput)

DescribeAppInstanceUserEndpointRequest generates a "aws/request.Request" representing the client's request for the DescribeAppInstanceUserEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAppInstanceUserEndpoint for more information on using the DescribeAppInstanceUserEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAppInstanceUserEndpointRequest method.
req, resp := client.DescribeAppInstanceUserEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceUserEndpoint

func (*ChimeSDKIdentity) DescribeAppInstanceUserEndpointWithContext added in v1.41.11

func (c *ChimeSDKIdentity) DescribeAppInstanceUserEndpointWithContext(ctx aws.Context, input *DescribeAppInstanceUserEndpointInput, opts ...request.Option) (*DescribeAppInstanceUserEndpointOutput, error)

DescribeAppInstanceUserEndpointWithContext is the same as DescribeAppInstanceUserEndpoint with the addition of the ability to pass a context and additional request options.

See DescribeAppInstanceUserEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DescribeAppInstanceUserRequest

func (c *ChimeSDKIdentity) DescribeAppInstanceUserRequest(input *DescribeAppInstanceUserInput) (req *request.Request, output *DescribeAppInstanceUserOutput)

DescribeAppInstanceUserRequest generates a "aws/request.Request" representing the client's request for the DescribeAppInstanceUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAppInstanceUser for more information on using the DescribeAppInstanceUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAppInstanceUserRequest method.
req, resp := client.DescribeAppInstanceUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceUser

func (*ChimeSDKIdentity) DescribeAppInstanceUserWithContext

func (c *ChimeSDKIdentity) DescribeAppInstanceUserWithContext(ctx aws.Context, input *DescribeAppInstanceUserInput, opts ...request.Option) (*DescribeAppInstanceUserOutput, error)

DescribeAppInstanceUserWithContext is the same as DescribeAppInstanceUser with the addition of the ability to pass a context and additional request options.

See DescribeAppInstanceUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) DescribeAppInstanceWithContext

func (c *ChimeSDKIdentity) DescribeAppInstanceWithContext(ctx aws.Context, input *DescribeAppInstanceInput, opts ...request.Option) (*DescribeAppInstanceOutput, error)

DescribeAppInstanceWithContext is the same as DescribeAppInstance with the addition of the ability to pass a context and additional request options.

See DescribeAppInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) GetAppInstanceRetentionSettings

GetAppInstanceRetentionSettings API operation for Amazon Chime SDK Identity.

Gets the retention settings for an AppInstance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation GetAppInstanceRetentionSettings for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/GetAppInstanceRetentionSettings

func (*ChimeSDKIdentity) GetAppInstanceRetentionSettingsRequest

func (c *ChimeSDKIdentity) GetAppInstanceRetentionSettingsRequest(input *GetAppInstanceRetentionSettingsInput) (req *request.Request, output *GetAppInstanceRetentionSettingsOutput)

GetAppInstanceRetentionSettingsRequest generates a "aws/request.Request" representing the client's request for the GetAppInstanceRetentionSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAppInstanceRetentionSettings for more information on using the GetAppInstanceRetentionSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAppInstanceRetentionSettingsRequest method.
req, resp := client.GetAppInstanceRetentionSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/GetAppInstanceRetentionSettings

func (*ChimeSDKIdentity) GetAppInstanceRetentionSettingsWithContext

func (c *ChimeSDKIdentity) GetAppInstanceRetentionSettingsWithContext(ctx aws.Context, input *GetAppInstanceRetentionSettingsInput, opts ...request.Option) (*GetAppInstanceRetentionSettingsOutput, error)

GetAppInstanceRetentionSettingsWithContext is the same as GetAppInstanceRetentionSettings with the addition of the ability to pass a context and additional request options.

See GetAppInstanceRetentionSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstanceAdmins

ListAppInstanceAdmins API operation for Amazon Chime SDK Identity.

Returns a list of the administrators in the AppInstance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation ListAppInstanceAdmins for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceAdmins

func (*ChimeSDKIdentity) ListAppInstanceAdminsPages

func (c *ChimeSDKIdentity) ListAppInstanceAdminsPages(input *ListAppInstanceAdminsInput, fn func(*ListAppInstanceAdminsOutput, bool) bool) error

ListAppInstanceAdminsPages iterates over the pages of a ListAppInstanceAdmins operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAppInstanceAdmins method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAppInstanceAdmins operation.
pageNum := 0
err := client.ListAppInstanceAdminsPages(params,
    func(page *chimesdkidentity.ListAppInstanceAdminsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ChimeSDKIdentity) ListAppInstanceAdminsPagesWithContext

func (c *ChimeSDKIdentity) ListAppInstanceAdminsPagesWithContext(ctx aws.Context, input *ListAppInstanceAdminsInput, fn func(*ListAppInstanceAdminsOutput, bool) bool, opts ...request.Option) error

ListAppInstanceAdminsPagesWithContext same as ListAppInstanceAdminsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstanceAdminsRequest

func (c *ChimeSDKIdentity) ListAppInstanceAdminsRequest(input *ListAppInstanceAdminsInput) (req *request.Request, output *ListAppInstanceAdminsOutput)

ListAppInstanceAdminsRequest generates a "aws/request.Request" representing the client's request for the ListAppInstanceAdmins operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAppInstanceAdmins for more information on using the ListAppInstanceAdmins API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAppInstanceAdminsRequest method.
req, resp := client.ListAppInstanceAdminsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceAdmins

func (*ChimeSDKIdentity) ListAppInstanceAdminsWithContext

func (c *ChimeSDKIdentity) ListAppInstanceAdminsWithContext(ctx aws.Context, input *ListAppInstanceAdminsInput, opts ...request.Option) (*ListAppInstanceAdminsOutput, error)

ListAppInstanceAdminsWithContext is the same as ListAppInstanceAdmins with the addition of the ability to pass a context and additional request options.

See ListAppInstanceAdmins for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstanceUserEndpoints added in v1.41.11

ListAppInstanceUserEndpoints API operation for Amazon Chime SDK Identity.

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation ListAppInstanceUserEndpoints for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUserEndpoints

func (*ChimeSDKIdentity) ListAppInstanceUserEndpointsPages added in v1.41.11

func (c *ChimeSDKIdentity) ListAppInstanceUserEndpointsPages(input *ListAppInstanceUserEndpointsInput, fn func(*ListAppInstanceUserEndpointsOutput, bool) bool) error

ListAppInstanceUserEndpointsPages iterates over the pages of a ListAppInstanceUserEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAppInstanceUserEndpoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAppInstanceUserEndpoints operation.
pageNum := 0
err := client.ListAppInstanceUserEndpointsPages(params,
    func(page *chimesdkidentity.ListAppInstanceUserEndpointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ChimeSDKIdentity) ListAppInstanceUserEndpointsPagesWithContext added in v1.41.11

func (c *ChimeSDKIdentity) ListAppInstanceUserEndpointsPagesWithContext(ctx aws.Context, input *ListAppInstanceUserEndpointsInput, fn func(*ListAppInstanceUserEndpointsOutput, bool) bool, opts ...request.Option) error

ListAppInstanceUserEndpointsPagesWithContext same as ListAppInstanceUserEndpointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstanceUserEndpointsRequest added in v1.41.11

func (c *ChimeSDKIdentity) ListAppInstanceUserEndpointsRequest(input *ListAppInstanceUserEndpointsInput) (req *request.Request, output *ListAppInstanceUserEndpointsOutput)

ListAppInstanceUserEndpointsRequest generates a "aws/request.Request" representing the client's request for the ListAppInstanceUserEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAppInstanceUserEndpoints for more information on using the ListAppInstanceUserEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAppInstanceUserEndpointsRequest method.
req, resp := client.ListAppInstanceUserEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUserEndpoints

func (*ChimeSDKIdentity) ListAppInstanceUserEndpointsWithContext added in v1.41.11

func (c *ChimeSDKIdentity) ListAppInstanceUserEndpointsWithContext(ctx aws.Context, input *ListAppInstanceUserEndpointsInput, opts ...request.Option) (*ListAppInstanceUserEndpointsOutput, error)

ListAppInstanceUserEndpointsWithContext is the same as ListAppInstanceUserEndpoints with the addition of the ability to pass a context and additional request options.

See ListAppInstanceUserEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstanceUsers

func (c *ChimeSDKIdentity) ListAppInstanceUsers(input *ListAppInstanceUsersInput) (*ListAppInstanceUsersOutput, error)

ListAppInstanceUsers API operation for Amazon Chime SDK Identity.

List all AppInstanceUsers created under a single AppInstance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation ListAppInstanceUsers for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUsers

func (*ChimeSDKIdentity) ListAppInstanceUsersPages

func (c *ChimeSDKIdentity) ListAppInstanceUsersPages(input *ListAppInstanceUsersInput, fn func(*ListAppInstanceUsersOutput, bool) bool) error

ListAppInstanceUsersPages iterates over the pages of a ListAppInstanceUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAppInstanceUsers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAppInstanceUsers operation.
pageNum := 0
err := client.ListAppInstanceUsersPages(params,
    func(page *chimesdkidentity.ListAppInstanceUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ChimeSDKIdentity) ListAppInstanceUsersPagesWithContext

func (c *ChimeSDKIdentity) ListAppInstanceUsersPagesWithContext(ctx aws.Context, input *ListAppInstanceUsersInput, fn func(*ListAppInstanceUsersOutput, bool) bool, opts ...request.Option) error

ListAppInstanceUsersPagesWithContext same as ListAppInstanceUsersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstanceUsersRequest

func (c *ChimeSDKIdentity) ListAppInstanceUsersRequest(input *ListAppInstanceUsersInput) (req *request.Request, output *ListAppInstanceUsersOutput)

ListAppInstanceUsersRequest generates a "aws/request.Request" representing the client's request for the ListAppInstanceUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAppInstanceUsers for more information on using the ListAppInstanceUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAppInstanceUsersRequest method.
req, resp := client.ListAppInstanceUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUsers

func (*ChimeSDKIdentity) ListAppInstanceUsersWithContext

func (c *ChimeSDKIdentity) ListAppInstanceUsersWithContext(ctx aws.Context, input *ListAppInstanceUsersInput, opts ...request.Option) (*ListAppInstanceUsersOutput, error)

ListAppInstanceUsersWithContext is the same as ListAppInstanceUsers with the addition of the ability to pass a context and additional request options.

See ListAppInstanceUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstances

func (c *ChimeSDKIdentity) ListAppInstances(input *ListAppInstancesInput) (*ListAppInstancesOutput, error)

ListAppInstances API operation for Amazon Chime SDK Identity.

Lists all Amazon Chime AppInstances created under a single AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation ListAppInstances for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstances

func (*ChimeSDKIdentity) ListAppInstancesPages

func (c *ChimeSDKIdentity) ListAppInstancesPages(input *ListAppInstancesInput, fn func(*ListAppInstancesOutput, bool) bool) error

ListAppInstancesPages iterates over the pages of a ListAppInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAppInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAppInstances operation.
pageNum := 0
err := client.ListAppInstancesPages(params,
    func(page *chimesdkidentity.ListAppInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ChimeSDKIdentity) ListAppInstancesPagesWithContext

func (c *ChimeSDKIdentity) ListAppInstancesPagesWithContext(ctx aws.Context, input *ListAppInstancesInput, fn func(*ListAppInstancesOutput, bool) bool, opts ...request.Option) error

ListAppInstancesPagesWithContext same as ListAppInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListAppInstancesRequest

func (c *ChimeSDKIdentity) ListAppInstancesRequest(input *ListAppInstancesInput) (req *request.Request, output *ListAppInstancesOutput)

ListAppInstancesRequest generates a "aws/request.Request" representing the client's request for the ListAppInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAppInstances for more information on using the ListAppInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAppInstancesRequest method.
req, resp := client.ListAppInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstances

func (*ChimeSDKIdentity) ListAppInstancesWithContext

func (c *ChimeSDKIdentity) ListAppInstancesWithContext(ctx aws.Context, input *ListAppInstancesInput, opts ...request.Option) (*ListAppInstancesOutput, error)

ListAppInstancesWithContext is the same as ListAppInstances with the addition of the ability to pass a context and additional request options.

See ListAppInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) ListTagsForResource added in v1.41.11

func (c *ChimeSDKIdentity) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Chime SDK Identity.

Lists the tags applied to an Amazon Chime SDK identity resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListTagsForResource

func (*ChimeSDKIdentity) ListTagsForResourceRequest added in v1.41.11

func (c *ChimeSDKIdentity) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListTagsForResource

func (*ChimeSDKIdentity) ListTagsForResourceWithContext added in v1.41.11

func (c *ChimeSDKIdentity) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) PutAppInstanceRetentionSettings

PutAppInstanceRetentionSettings API operation for Amazon Chime SDK Identity.

Sets the amount of time in days that a given AppInstance retains data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation PutAppInstanceRetentionSettings for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceRetentionSettings

func (*ChimeSDKIdentity) PutAppInstanceRetentionSettingsRequest

func (c *ChimeSDKIdentity) PutAppInstanceRetentionSettingsRequest(input *PutAppInstanceRetentionSettingsInput) (req *request.Request, output *PutAppInstanceRetentionSettingsOutput)

PutAppInstanceRetentionSettingsRequest generates a "aws/request.Request" representing the client's request for the PutAppInstanceRetentionSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAppInstanceRetentionSettings for more information on using the PutAppInstanceRetentionSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutAppInstanceRetentionSettingsRequest method.
req, resp := client.PutAppInstanceRetentionSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceRetentionSettings

func (*ChimeSDKIdentity) PutAppInstanceRetentionSettingsWithContext

func (c *ChimeSDKIdentity) PutAppInstanceRetentionSettingsWithContext(ctx aws.Context, input *PutAppInstanceRetentionSettingsInput, opts ...request.Option) (*PutAppInstanceRetentionSettingsOutput, error)

PutAppInstanceRetentionSettingsWithContext is the same as PutAppInstanceRetentionSettings with the addition of the ability to pass a context and additional request options.

See PutAppInstanceRetentionSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) RegisterAppInstanceUserEndpoint added in v1.41.11

RegisterAppInstanceUserEndpoint API operation for Amazon Chime SDK Identity.

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation RegisterAppInstanceUserEndpoint for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/RegisterAppInstanceUserEndpoint

func (*ChimeSDKIdentity) RegisterAppInstanceUserEndpointRequest added in v1.41.11

func (c *ChimeSDKIdentity) RegisterAppInstanceUserEndpointRequest(input *RegisterAppInstanceUserEndpointInput) (req *request.Request, output *RegisterAppInstanceUserEndpointOutput)

RegisterAppInstanceUserEndpointRequest generates a "aws/request.Request" representing the client's request for the RegisterAppInstanceUserEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterAppInstanceUserEndpoint for more information on using the RegisterAppInstanceUserEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterAppInstanceUserEndpointRequest method.
req, resp := client.RegisterAppInstanceUserEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/RegisterAppInstanceUserEndpoint

func (*ChimeSDKIdentity) RegisterAppInstanceUserEndpointWithContext added in v1.41.11

func (c *ChimeSDKIdentity) RegisterAppInstanceUserEndpointWithContext(ctx aws.Context, input *RegisterAppInstanceUserEndpointInput, opts ...request.Option) (*RegisterAppInstanceUserEndpointOutput, error)

RegisterAppInstanceUserEndpointWithContext is the same as RegisterAppInstanceUserEndpoint with the addition of the ability to pass a context and additional request options.

See RegisterAppInstanceUserEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) TagResource added in v1.41.11

func (c *ChimeSDKIdentity) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Chime SDK Identity.

Applies the specified tags to the specified Amazon Chime SDK identity resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation TagResource for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/TagResource

func (*ChimeSDKIdentity) TagResourceRequest added in v1.41.11

func (c *ChimeSDKIdentity) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/TagResource

func (*ChimeSDKIdentity) TagResourceWithContext added in v1.41.11

func (c *ChimeSDKIdentity) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) UntagResource added in v1.41.11

func (c *ChimeSDKIdentity) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Chime SDK Identity.

Removes the specified tags from the specified Amazon Chime SDK identity resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation UntagResource for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UntagResource

func (*ChimeSDKIdentity) UntagResourceRequest added in v1.41.11

func (c *ChimeSDKIdentity) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UntagResource

func (*ChimeSDKIdentity) UntagResourceWithContext added in v1.41.11

func (c *ChimeSDKIdentity) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) UpdateAppInstance

func (c *ChimeSDKIdentity) UpdateAppInstance(input *UpdateAppInstanceInput) (*UpdateAppInstanceOutput, error)

UpdateAppInstance API operation for Amazon Chime SDK Identity.

Updates AppInstance metadata.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation UpdateAppInstance for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstance

func (*ChimeSDKIdentity) UpdateAppInstanceRequest

func (c *ChimeSDKIdentity) UpdateAppInstanceRequest(input *UpdateAppInstanceInput) (req *request.Request, output *UpdateAppInstanceOutput)

UpdateAppInstanceRequest generates a "aws/request.Request" representing the client's request for the UpdateAppInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAppInstance for more information on using the UpdateAppInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAppInstanceRequest method.
req, resp := client.UpdateAppInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstance

func (*ChimeSDKIdentity) UpdateAppInstanceUser

UpdateAppInstanceUser API operation for Amazon Chime SDK Identity.

Updates the details of an AppInstanceUser. You can update names and metadata.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation UpdateAppInstanceUser for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceUser

func (*ChimeSDKIdentity) UpdateAppInstanceUserEndpoint added in v1.41.11

UpdateAppInstanceUserEndpoint API operation for Amazon Chime SDK Identity.

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Identity's API operation UpdateAppInstanceUserEndpoint for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ConflictException The request could not be processed because of conflict in the current state of the resource.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceUserEndpoint

func (*ChimeSDKIdentity) UpdateAppInstanceUserEndpointRequest added in v1.41.11

func (c *ChimeSDKIdentity) UpdateAppInstanceUserEndpointRequest(input *UpdateAppInstanceUserEndpointInput) (req *request.Request, output *UpdateAppInstanceUserEndpointOutput)

UpdateAppInstanceUserEndpointRequest generates a "aws/request.Request" representing the client's request for the UpdateAppInstanceUserEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAppInstanceUserEndpoint for more information on using the UpdateAppInstanceUserEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAppInstanceUserEndpointRequest method.
req, resp := client.UpdateAppInstanceUserEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceUserEndpoint

func (*ChimeSDKIdentity) UpdateAppInstanceUserEndpointWithContext added in v1.41.11

func (c *ChimeSDKIdentity) UpdateAppInstanceUserEndpointWithContext(ctx aws.Context, input *UpdateAppInstanceUserEndpointInput, opts ...request.Option) (*UpdateAppInstanceUserEndpointOutput, error)

UpdateAppInstanceUserEndpointWithContext is the same as UpdateAppInstanceUserEndpoint with the addition of the ability to pass a context and additional request options.

See UpdateAppInstanceUserEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) UpdateAppInstanceUserRequest

func (c *ChimeSDKIdentity) UpdateAppInstanceUserRequest(input *UpdateAppInstanceUserInput) (req *request.Request, output *UpdateAppInstanceUserOutput)

UpdateAppInstanceUserRequest generates a "aws/request.Request" representing the client's request for the UpdateAppInstanceUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAppInstanceUser for more information on using the UpdateAppInstanceUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAppInstanceUserRequest method.
req, resp := client.UpdateAppInstanceUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceUser

func (*ChimeSDKIdentity) UpdateAppInstanceUserWithContext

func (c *ChimeSDKIdentity) UpdateAppInstanceUserWithContext(ctx aws.Context, input *UpdateAppInstanceUserInput, opts ...request.Option) (*UpdateAppInstanceUserOutput, error)

UpdateAppInstanceUserWithContext is the same as UpdateAppInstanceUser with the addition of the ability to pass a context and additional request options.

See UpdateAppInstanceUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKIdentity) UpdateAppInstanceWithContext

func (c *ChimeSDKIdentity) UpdateAppInstanceWithContext(ctx aws.Context, input *UpdateAppInstanceInput, opts ...request.Option) (*UpdateAppInstanceOutput, error)

UpdateAppInstanceWithContext is the same as UpdateAppInstance with the addition of the ability to pass a context and additional request options.

See UpdateAppInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAppInstanceAdminInput

type CreateAppInstanceAdminInput struct {

	// The ARN of the administrator of the current AppInstance.
	//
	// AppInstanceAdminArn is a required field
	AppInstanceAdminArn *string `min:"5" type:"string" required:"true"`

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAppInstanceAdminInput) GoString

func (s CreateAppInstanceAdminInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceAdminInput) SetAppInstanceAdminArn

func (s *CreateAppInstanceAdminInput) SetAppInstanceAdminArn(v string) *CreateAppInstanceAdminInput

SetAppInstanceAdminArn sets the AppInstanceAdminArn field's value.

func (*CreateAppInstanceAdminInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (CreateAppInstanceAdminInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceAdminInput) Validate

func (s *CreateAppInstanceAdminInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAppInstanceAdminOutput

type CreateAppInstanceAdminOutput struct {

	// The name and ARN of the admin for the AppInstance.
	AppInstanceAdmin *Identity `type:"structure"`

	// The ARN of the of the admin for the AppInstance.
	AppInstanceArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAppInstanceAdminOutput) GoString

func (s CreateAppInstanceAdminOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceAdminOutput) SetAppInstanceAdmin

SetAppInstanceAdmin sets the AppInstanceAdmin field's value.

func (*CreateAppInstanceAdminOutput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (CreateAppInstanceAdminOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAppInstanceInput

type CreateAppInstanceInput struct {

	// The ClientRequestToken of the AppInstance.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceInput's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The name of the AppInstance.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Tags assigned to the AppInstanceUser.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateAppInstanceInput) GoString

func (s CreateAppInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceInput) SetClientRequestToken

func (s *CreateAppInstanceInput) SetClientRequestToken(v string) *CreateAppInstanceInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateAppInstanceInput) SetMetadata

SetMetadata sets the Metadata field's value.

func (*CreateAppInstanceInput) SetName

SetName sets the Name field's value.

func (*CreateAppInstanceInput) SetTags

SetTags sets the Tags field's value.

func (CreateAppInstanceInput) String

func (s CreateAppInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceInput) Validate

func (s *CreateAppInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAppInstanceOutput

type CreateAppInstanceOutput struct {

	// The Amazon Resource Number (ARN) of the AppInstance.
	AppInstanceArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAppInstanceOutput) GoString

func (s CreateAppInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceOutput) SetAppInstanceArn

func (s *CreateAppInstanceOutput) SetAppInstanceArn(v string) *CreateAppInstanceOutput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (CreateAppInstanceOutput) String

func (s CreateAppInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAppInstanceUserInput

type CreateAppInstanceUserInput struct {

	// The ARN of the AppInstance request.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `min:"5" type:"string" required:"true"`

	// The user ID of the AppInstance.
	//
	// AppInstanceUserId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceUserInput's
	// String and GoString methods.
	//
	// AppInstanceUserId is a required field
	AppInstanceUserId *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The token assigned to the user requesting an AppInstance.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceUserInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The request's metadata. Limited to a 1KB string in UTF-8.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceUserInput's
	// String and GoString methods.
	Metadata *string `type:"string" sensitive:"true"`

	// The user's name.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAppInstanceUserInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Tags assigned to the AppInstanceUser.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateAppInstanceUserInput) GoString

func (s CreateAppInstanceUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceUserInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*CreateAppInstanceUserInput) SetAppInstanceUserId

func (s *CreateAppInstanceUserInput) SetAppInstanceUserId(v string) *CreateAppInstanceUserInput

SetAppInstanceUserId sets the AppInstanceUserId field's value.

func (*CreateAppInstanceUserInput) SetClientRequestToken

func (s *CreateAppInstanceUserInput) SetClientRequestToken(v string) *CreateAppInstanceUserInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateAppInstanceUserInput) SetMetadata

SetMetadata sets the Metadata field's value.

func (*CreateAppInstanceUserInput) SetName

SetName sets the Name field's value.

func (*CreateAppInstanceUserInput) SetTags

SetTags sets the Tags field's value.

func (CreateAppInstanceUserInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceUserInput) Validate

func (s *CreateAppInstanceUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAppInstanceUserOutput

type CreateAppInstanceUserOutput struct {

	// The user's ARN.
	AppInstanceUserArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAppInstanceUserOutput) GoString

func (s CreateAppInstanceUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppInstanceUserOutput) SetAppInstanceUserArn

func (s *CreateAppInstanceUserOutput) SetAppInstanceUserArn(v string) *CreateAppInstanceUserOutput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (CreateAppInstanceUserOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAppInstanceAdminInput

type DeleteAppInstanceAdminInput struct {

	// The ARN of the AppInstance's administrator.
	//
	// AppInstanceAdminArn is a required field
	AppInstanceAdminArn *string `location:"uri" locationName:"appInstanceAdminArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAppInstanceAdminInput) GoString

func (s DeleteAppInstanceAdminInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInstanceAdminInput) SetAppInstanceAdminArn

func (s *DeleteAppInstanceAdminInput) SetAppInstanceAdminArn(v string) *DeleteAppInstanceAdminInput

SetAppInstanceAdminArn sets the AppInstanceAdminArn field's value.

func (*DeleteAppInstanceAdminInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (DeleteAppInstanceAdminInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInstanceAdminInput) Validate

func (s *DeleteAppInstanceAdminInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAppInstanceAdminOutput

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

func (DeleteAppInstanceAdminOutput) GoString

func (s DeleteAppInstanceAdminOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAppInstanceAdminOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAppInstanceInput

type DeleteAppInstanceInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAppInstanceInput) GoString

func (s DeleteAppInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInstanceInput) SetAppInstanceArn

func (s *DeleteAppInstanceInput) SetAppInstanceArn(v string) *DeleteAppInstanceInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (DeleteAppInstanceInput) String

func (s DeleteAppInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInstanceInput) Validate

func (s *DeleteAppInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAppInstanceOutput

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

func (DeleteAppInstanceOutput) GoString

func (s DeleteAppInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAppInstanceOutput) String

func (s DeleteAppInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAppInstanceUserInput

type DeleteAppInstanceUserInput struct {

	// The ARN of the user request being deleted.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAppInstanceUserInput) GoString

func (s DeleteAppInstanceUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInstanceUserInput) SetAppInstanceUserArn

func (s *DeleteAppInstanceUserInput) SetAppInstanceUserArn(v string) *DeleteAppInstanceUserInput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (DeleteAppInstanceUserInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInstanceUserInput) Validate

func (s *DeleteAppInstanceUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAppInstanceUserOutput

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

func (DeleteAppInstanceUserOutput) GoString

func (s DeleteAppInstanceUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAppInstanceUserOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeregisterAppInstanceUserEndpointInput added in v1.41.11

type DeregisterAppInstanceUserEndpointInput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeregisterAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true" sensitive:"true"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeregisterAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// EndpointId is a required field
	EndpointId *string `location:"uri" locationName:"endpointId" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DeregisterAppInstanceUserEndpointInput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterAppInstanceUserEndpointInput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*DeregisterAppInstanceUserEndpointInput) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (DeregisterAppInstanceUserEndpointInput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterAppInstanceUserEndpointInput) Validate added in v1.41.11

Validate inspects the fields of the type to determine if they are valid.

type DeregisterAppInstanceUserEndpointOutput added in v1.41.11

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

func (DeregisterAppInstanceUserEndpointOutput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterAppInstanceUserEndpointOutput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAppInstanceAdminInput

type DescribeAppInstanceAdminInput struct {

	// The ARN of the AppInstanceAdmin.
	//
	// AppInstanceAdminArn is a required field
	AppInstanceAdminArn *string `location:"uri" locationName:"appInstanceAdminArn" min:"5" type:"string" required:"true"`

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceAdminInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceAdminInput) SetAppInstanceAdminArn

SetAppInstanceAdminArn sets the AppInstanceAdminArn field's value.

func (*DescribeAppInstanceAdminInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (DescribeAppInstanceAdminInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceAdminInput) Validate

func (s *DescribeAppInstanceAdminInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAppInstanceAdminOutput

type DescribeAppInstanceAdminOutput struct {

	// The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and
	// the created and last-updated timestamps. All timestamps use epoch milliseconds.
	AppInstanceAdmin *AppInstanceAdmin `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceAdminOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceAdminOutput) SetAppInstanceAdmin

SetAppInstanceAdmin sets the AppInstanceAdmin field's value.

func (DescribeAppInstanceAdminOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAppInstanceInput

type DescribeAppInstanceInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceInput) GoString

func (s DescribeAppInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceInput) SetAppInstanceArn

func (s *DescribeAppInstanceInput) SetAppInstanceArn(v string) *DescribeAppInstanceInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (DescribeAppInstanceInput) String

func (s DescribeAppInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceInput) Validate

func (s *DescribeAppInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAppInstanceOutput

type DescribeAppInstanceOutput struct {

	// The ARN, metadata, created and last-updated timestamps, and the name of the
	// AppInstance. All timestamps use epoch milliseconds.
	AppInstance *AppInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceOutput) GoString

func (s DescribeAppInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceOutput) SetAppInstance

SetAppInstance sets the AppInstance field's value.

func (DescribeAppInstanceOutput) String

func (s DescribeAppInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAppInstanceUserEndpointInput added in v1.41.11

type DescribeAppInstanceUserEndpointInput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" type:"string" required:"true" sensitive:"true"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// EndpointId is a required field
	EndpointId *string `location:"uri" locationName:"endpointId" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceUserEndpointInput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceUserEndpointInput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*DescribeAppInstanceUserEndpointInput) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (DescribeAppInstanceUserEndpointInput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceUserEndpointInput) Validate added in v1.41.11

Validate inspects the fields of the type to determine if they are valid.

type DescribeAppInstanceUserEndpointOutput added in v1.41.11

type DescribeAppInstanceUserEndpointOutput struct {

	// The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID,
	// name, type, resource ARN, attributes, allow messages, state, and created
	// and last updated timestamps. All timestamps use epoch milliseconds.
	AppInstanceUserEndpoint *AppInstanceUserEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceUserEndpointOutput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceUserEndpointOutput) SetAppInstanceUserEndpoint added in v1.41.11

SetAppInstanceUserEndpoint sets the AppInstanceUserEndpoint field's value.

func (DescribeAppInstanceUserEndpointOutput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAppInstanceUserInput

type DescribeAppInstanceUserInput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceUserInput) GoString

func (s DescribeAppInstanceUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceUserInput) SetAppInstanceUserArn

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (DescribeAppInstanceUserInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceUserInput) Validate

func (s *DescribeAppInstanceUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAppInstanceUserOutput

type DescribeAppInstanceUserOutput struct {

	// The name of the AppInstanceUser.
	AppInstanceUser *AppInstanceUser `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAppInstanceUserOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInstanceUserOutput) SetAppInstanceUser

SetAppInstanceUser sets the AppInstanceUser field's value.

func (DescribeAppInstanceUserOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointAttributes added in v1.41.11

type EndpointAttributes struct {

	// The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
	//
	// DeviceToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EndpointAttributes's
	// String and GoString methods.
	//
	// DeviceToken is a required field
	DeviceToken *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
	//
	// VoipDeviceToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EndpointAttributes's
	// String and GoString methods.
	VoipDeviceToken *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The attributes of an Endpoint.

func (EndpointAttributes) GoString added in v1.41.11

func (s EndpointAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointAttributes) SetDeviceToken added in v1.41.11

func (s *EndpointAttributes) SetDeviceToken(v string) *EndpointAttributes

SetDeviceToken sets the DeviceToken field's value.

func (*EndpointAttributes) SetVoipDeviceToken added in v1.41.11

func (s *EndpointAttributes) SetVoipDeviceToken(v string) *EndpointAttributes

SetVoipDeviceToken sets the VoipDeviceToken field's value.

func (EndpointAttributes) String added in v1.41.11

func (s EndpointAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointAttributes) Validate added in v1.41.11

func (s *EndpointAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EndpointState added in v1.41.11

type EndpointState struct {

	// Enum that indicates the Status of an AppInstanceUserEndpoint.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"EndpointStatus"`

	// The reason for the EndpointStatus.
	StatusReason *string `type:"string" enum:"EndpointStatusReason"`
	// contains filtered or unexported fields
}

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

  • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

  • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

func (EndpointState) GoString added in v1.41.11

func (s EndpointState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointState) SetStatus added in v1.41.11

func (s *EndpointState) SetStatus(v string) *EndpointState

SetStatus sets the Status field's value.

func (*EndpointState) SetStatusReason added in v1.41.11

func (s *EndpointState) SetStatusReason(v string) *EndpointState

SetStatusReason sets the StatusReason field's value.

func (EndpointState) String added in v1.41.11

func (s EndpointState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ForbiddenException

type ForbiddenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The client is permanently forbidden from making the request.

func (*ForbiddenException) Code

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString

func (s ForbiddenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForbiddenException) Message

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode

func (s *ForbiddenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ForbiddenException) String

func (s ForbiddenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAppInstanceRetentionSettingsInput

type GetAppInstanceRetentionSettingsInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppInstanceRetentionSettingsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppInstanceRetentionSettingsInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (GetAppInstanceRetentionSettingsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppInstanceRetentionSettingsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetAppInstanceRetentionSettingsOutput

type GetAppInstanceRetentionSettingsOutput struct {

	// The retention settings for the AppInstance.
	AppInstanceRetentionSettings *AppInstanceRetentionSettings `type:"structure"`

	// The timestamp representing the time at which the specified items are retained,
	// in Epoch Seconds.
	InitiateDeletionTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetAppInstanceRetentionSettingsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppInstanceRetentionSettingsOutput) SetAppInstanceRetentionSettings

SetAppInstanceRetentionSettings sets the AppInstanceRetentionSettings field's value.

func (*GetAppInstanceRetentionSettingsOutput) SetInitiateDeletionTimestamp

SetInitiateDeletionTimestamp sets the InitiateDeletionTimestamp field's value.

func (GetAppInstanceRetentionSettingsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Identity

type Identity struct {

	// The ARN in an Identity.
	Arn *string `min:"5" type:"string"`

	// The name in an Identity.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Identity's
	// String and GoString methods.
	Name *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The details of a user.

func (Identity) GoString

func (s Identity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Identity) SetArn

func (s *Identity) SetArn(v string) *Identity

SetArn sets the Arn field's value.

func (*Identity) SetName

func (s *Identity) SetName(v string) *Identity

SetName sets the Name field's value.

func (Identity) String

func (s Identity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppInstanceAdminsInput

type ListAppInstanceAdminsInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`

	// The maximum number of administrators that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token returned from previous API requests until the number of administrators
	// is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceAdminsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstanceAdminsInput) GoString

func (s ListAppInstanceAdminsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceAdminsInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*ListAppInstanceAdminsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAppInstanceAdminsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAppInstanceAdminsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceAdminsInput) Validate

func (s *ListAppInstanceAdminsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAppInstanceAdminsOutput

type ListAppInstanceAdminsOutput struct {

	// The information for each administrator.
	AppInstanceAdmins []*AppInstanceAdminSummary `type:"list"`

	// The ARN of the AppInstance.
	AppInstanceArn *string `min:"5" type:"string"`

	// The token returned from previous API requests until the number of administrators
	// is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceAdminsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstanceAdminsOutput) GoString

func (s ListAppInstanceAdminsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceAdminsOutput) SetAppInstanceAdmins

SetAppInstanceAdmins sets the AppInstanceAdmins field's value.

func (*ListAppInstanceAdminsOutput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*ListAppInstanceAdminsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAppInstanceAdminsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppInstanceUserEndpointsInput added in v1.41.11

type ListAppInstanceUserEndpointsInput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceUserEndpointsInput's
	// String and GoString methods.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true" sensitive:"true"`

	// The maximum number of endpoints that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested endpoints are
	// returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceUserEndpointsInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstanceUserEndpointsInput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceUserEndpointsInput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*ListAppInstanceUserEndpointsInput) SetMaxResults added in v1.41.11

SetMaxResults sets the MaxResults field's value.

func (*ListAppInstanceUserEndpointsInput) SetNextToken added in v1.41.11

SetNextToken sets the NextToken field's value.

func (ListAppInstanceUserEndpointsInput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceUserEndpointsInput) Validate added in v1.41.11

Validate inspects the fields of the type to determine if they are valid.

type ListAppInstanceUserEndpointsOutput added in v1.41.11

type ListAppInstanceUserEndpointsOutput struct {

	// The information for each requested AppInstanceUserEndpoint.
	AppInstanceUserEndpoints []*AppInstanceUserEndpointSummary `type:"list"`

	// The token passed by previous API calls until all requested endpoints are
	// returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceUserEndpointsOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstanceUserEndpointsOutput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceUserEndpointsOutput) SetAppInstanceUserEndpoints added in v1.41.11

SetAppInstanceUserEndpoints sets the AppInstanceUserEndpoints field's value.

func (*ListAppInstanceUserEndpointsOutput) SetNextToken added in v1.41.11

SetNextToken sets the NextToken field's value.

func (ListAppInstanceUserEndpointsOutput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppInstanceUsersInput

type ListAppInstanceUsersInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"querystring" locationName:"app-instance-arn" min:"5" type:"string" required:"true"`

	// The maximum number of requests that you want returned.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API calls until all requested users are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceUsersInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstanceUsersInput) GoString

func (s ListAppInstanceUsersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceUsersInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*ListAppInstanceUsersInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAppInstanceUsersInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAppInstanceUsersInput) String

func (s ListAppInstanceUsersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceUsersInput) Validate

func (s *ListAppInstanceUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAppInstanceUsersOutput

type ListAppInstanceUsersOutput struct {

	// The ARN of the AppInstance.
	AppInstanceArn *string `min:"5" type:"string"`

	// The information for each requested AppInstanceUser.
	AppInstanceUsers []*AppInstanceUserSummary `type:"list"`

	// The token passed by previous API calls until all requested users are returned.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstanceUsersOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstanceUsersOutput) GoString

func (s ListAppInstanceUsersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstanceUsersOutput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*ListAppInstanceUsersOutput) SetAppInstanceUsers

SetAppInstanceUsers sets the AppInstanceUsers field's value.

func (*ListAppInstanceUsersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAppInstanceUsersOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppInstancesInput

type ListAppInstancesInput struct {

	// The maximum number of AppInstances that you want to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token passed by previous API requests until you reach the maximum number
	// of AppInstances.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstancesInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstancesInput) GoString

func (s ListAppInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstancesInput) SetMaxResults

func (s *ListAppInstancesInput) SetMaxResults(v int64) *ListAppInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAppInstancesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAppInstancesInput) String

func (s ListAppInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstancesInput) Validate

func (s *ListAppInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAppInstancesOutput

type ListAppInstancesOutput struct {

	// The information for each AppInstance.
	AppInstances []*AppInstanceSummary `type:"list"`

	// The token passed by previous API requests until the maximum number of AppInstances
	// is reached.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListAppInstancesOutput's
	// String and GoString methods.
	NextToken *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAppInstancesOutput) GoString

func (s ListAppInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppInstancesOutput) SetAppInstances

SetAppInstances sets the AppInstances field's value.

func (*ListAppInstancesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAppInstancesOutput) String

func (s ListAppInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.41.11

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"querystring" locationName:"arn" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.41.11

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN added in v1.41.11

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.41.11

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.41.11

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.41.11

type ListTagsForResourceOutput struct {

	// The tag key-value pairs.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.41.11

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.41.11

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.41.11

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutAppInstanceRetentionSettingsInput

type PutAppInstanceRetentionSettingsInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`

	// The time in days to retain data. Data type: number.
	//
	// AppInstanceRetentionSettings is a required field
	AppInstanceRetentionSettings *AppInstanceRetentionSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutAppInstanceRetentionSettingsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAppInstanceRetentionSettingsInput) SetAppInstanceArn

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*PutAppInstanceRetentionSettingsInput) SetAppInstanceRetentionSettings

SetAppInstanceRetentionSettings sets the AppInstanceRetentionSettings field's value.

func (PutAppInstanceRetentionSettingsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAppInstanceRetentionSettingsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutAppInstanceRetentionSettingsOutput

type PutAppInstanceRetentionSettingsOutput struct {

	// The time in days to retain data. Data type: number.
	AppInstanceRetentionSettings *AppInstanceRetentionSettings `type:"structure"`

	// The time at which the API deletes data.
	InitiateDeletionTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (PutAppInstanceRetentionSettingsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAppInstanceRetentionSettingsOutput) SetAppInstanceRetentionSettings

SetAppInstanceRetentionSettings sets the AppInstanceRetentionSettings field's value.

func (*PutAppInstanceRetentionSettingsOutput) SetInitiateDeletionTimestamp

SetInitiateDeletionTimestamp sets the InitiateDeletionTimestamp field's value.

func (PutAppInstanceRetentionSettingsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterAppInstanceUserEndpointInput added in v1.41.11

type RegisterAppInstanceUserEndpointInput struct {

	// Boolean that controls whether the AppInstanceUserEndpoint is opted in to
	// receive messages. ALL indicates the endpoint receives all messages. NONE
	// indicates the endpoint receives no messages.
	AllowMessages *string `type:"string" enum:"AllowMessages"`

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true" sensitive:"true"`

	// The idempotency token for each client request.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterAppInstanceUserEndpointInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The attributes of an Endpoint.
	//
	// EndpointAttributes is a required field
	EndpointAttributes *EndpointAttributes `type:"structure" required:"true"`

	// The name of the AppInstanceUserEndpoint.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterAppInstanceUserEndpointInput's
	// String and GoString methods.
	Name *string `type:"string" sensitive:"true"`

	// The ARN of the resource to which the endpoint belongs.
	//
	// ResourceArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"5" type:"string" required:"true" sensitive:"true"`

	// The type of the AppInstanceUserEndpoint. Supported types:
	//
	//    * APNS: The mobile notification service for an Apple device.
	//
	//    * APNS_SANDBOX: The sandbox environment of the mobile notification service
	//    for an Apple device.
	//
	//    * GCM: The mobile notification service for an Android device.
	//
	// Populate the ResourceArn value of each type as PinpointAppArn.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"AppInstanceUserEndpointType"`
	// contains filtered or unexported fields
}

func (RegisterAppInstanceUserEndpointInput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterAppInstanceUserEndpointInput) SetAllowMessages added in v1.41.11

SetAllowMessages sets the AllowMessages field's value.

func (*RegisterAppInstanceUserEndpointInput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*RegisterAppInstanceUserEndpointInput) SetClientRequestToken added in v1.41.11

SetClientRequestToken sets the ClientRequestToken field's value.

func (*RegisterAppInstanceUserEndpointInput) SetEndpointAttributes added in v1.41.11

SetEndpointAttributes sets the EndpointAttributes field's value.

func (*RegisterAppInstanceUserEndpointInput) SetName added in v1.41.11

SetName sets the Name field's value.

func (*RegisterAppInstanceUserEndpointInput) SetResourceArn added in v1.41.11

SetResourceArn sets the ResourceArn field's value.

func (*RegisterAppInstanceUserEndpointInput) SetType added in v1.41.11

SetType sets the Type field's value.

func (RegisterAppInstanceUserEndpointInput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterAppInstanceUserEndpointInput) Validate added in v1.41.11

Validate inspects the fields of the type to determine if they are valid.

type RegisterAppInstanceUserEndpointOutput added in v1.41.11

type RegisterAppInstanceUserEndpointOutput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterAppInstanceUserEndpointOutput's
	// String and GoString methods.
	AppInstanceUserArn *string `min:"5" type:"string" sensitive:"true"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RegisterAppInstanceUserEndpointOutput's
	// String and GoString methods.
	EndpointId *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (RegisterAppInstanceUserEndpointOutput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterAppInstanceUserEndpointOutput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*RegisterAppInstanceUserEndpointOutput) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (RegisterAppInstanceUserEndpointOutput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceLimitExceededException

type ResourceLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request exceeds the resource limit.

func (*ResourceLimitExceededException) Code

Code returns the exception type name.

func (*ResourceLimitExceededException) Error

func (ResourceLimitExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceLimitExceededException) Message

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode

func (s *ResourceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceFailureException

type ServiceFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The service encountered an unexpected error.

func (*ServiceFailureException) Code

func (s *ServiceFailureException) Code() string

Code returns the exception type name.

func (*ServiceFailureException) Error

func (s *ServiceFailureException) Error() string

func (ServiceFailureException) GoString

func (s ServiceFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceFailureException) Message

func (s *ServiceFailureException) Message() string

Message returns the exception's message.

func (*ServiceFailureException) OrigErr

func (s *ServiceFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceFailureException) RequestID

func (s *ServiceFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceFailureException) StatusCode

func (s *ServiceFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceFailureException) String

func (s ServiceFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailableException) Code

Code returns the exception type name.

func (*ServiceUnavailableException) Error

func (ServiceUnavailableException) GoString

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

	// The key in a tag.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The value in a tag.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

A tag object containing a key-value pair.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.41.11

type TagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"5" type:"string" required:"true"`

	// The tag key-value pairs.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.41.11

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.41.11

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.41.11

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.41.11

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.41.11

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.41.11

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

func (TagResourceOutput) GoString added in v1.41.11

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.41.11

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottledClientException

type ThrottledClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The client exceeded its request rate limit.

func (*ThrottledClientException) Code

func (s *ThrottledClientException) Code() string

Code returns the exception type name.

func (*ThrottledClientException) Error

func (s *ThrottledClientException) Error() string

func (ThrottledClientException) GoString

func (s ThrottledClientException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottledClientException) Message

func (s *ThrottledClientException) Message() string

Message returns the exception's message.

func (*ThrottledClientException) OrigErr

func (s *ThrottledClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottledClientException) RequestID

func (s *ThrottledClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottledClientException) StatusCode

func (s *ThrottledClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottledClientException) String

func (s ThrottledClientException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedClientException

type UnauthorizedClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The client is not currently authorized to make the request.

func (*UnauthorizedClientException) Code

Code returns the exception type name.

func (*UnauthorizedClientException) Error

func (UnauthorizedClientException) GoString

func (s UnauthorizedClientException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedClientException) Message

func (s *UnauthorizedClientException) Message() string

Message returns the exception's message.

func (*UnauthorizedClientException) OrigErr

func (s *UnauthorizedClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedClientException) RequestID

func (s *UnauthorizedClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedClientException) StatusCode

func (s *UnauthorizedClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedClientException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.41.11

type UntagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"5" type:"string" required:"true"`

	// The tag keys.
	//
	// TagKeys is a required field
	TagKeys []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.41.11

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.41.11

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.41.11

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.41.11

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.41.11

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.41.11

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

func (UntagResourceOutput) GoString added in v1.41.11

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.41.11

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAppInstanceInput

type UpdateAppInstanceInput struct {

	// The ARN of the AppInstance.
	//
	// AppInstanceArn is a required field
	AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"`

	// The metadata that you want to change.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceInput's
	// String and GoString methods.
	//
	// Metadata is a required field
	Metadata *string `type:"string" required:"true" sensitive:"true"`

	// The name that you want to change.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateAppInstanceInput) GoString

func (s UpdateAppInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceInput) SetAppInstanceArn

func (s *UpdateAppInstanceInput) SetAppInstanceArn(v string) *UpdateAppInstanceInput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (*UpdateAppInstanceInput) SetMetadata

SetMetadata sets the Metadata field's value.

func (*UpdateAppInstanceInput) SetName

SetName sets the Name field's value.

func (UpdateAppInstanceInput) String

func (s UpdateAppInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceInput) Validate

func (s *UpdateAppInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAppInstanceOutput

type UpdateAppInstanceOutput struct {

	// The ARN of the AppInstance.
	AppInstanceArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAppInstanceOutput) GoString

func (s UpdateAppInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceOutput) SetAppInstanceArn

func (s *UpdateAppInstanceOutput) SetAppInstanceArn(v string) *UpdateAppInstanceOutput

SetAppInstanceArn sets the AppInstanceArn field's value.

func (UpdateAppInstanceOutput) String

func (s UpdateAppInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAppInstanceUserEndpointInput added in v1.41.11

type UpdateAppInstanceUserEndpointInput struct {

	// Boolean that controls whether the AppInstanceUserEndpoint is opted in to
	// receive messages. ALL indicates the endpoint will receive all messages. NONE
	// indicates the endpoint will receive no messages.
	AllowMessages *string `type:"string" enum:"AllowMessages"`

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true" sensitive:"true"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserEndpointInput's
	// String and GoString methods.
	//
	// EndpointId is a required field
	EndpointId *string `location:"uri" locationName:"endpointId" type:"string" required:"true" sensitive:"true"`

	// The name of the AppInstanceUserEndpoint.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserEndpointInput's
	// String and GoString methods.
	Name *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateAppInstanceUserEndpointInput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceUserEndpointInput) SetAllowMessages added in v1.41.11

SetAllowMessages sets the AllowMessages field's value.

func (*UpdateAppInstanceUserEndpointInput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*UpdateAppInstanceUserEndpointInput) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (*UpdateAppInstanceUserEndpointInput) SetName added in v1.41.11

SetName sets the Name field's value.

func (UpdateAppInstanceUserEndpointInput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceUserEndpointInput) Validate added in v1.41.11

Validate inspects the fields of the type to determine if they are valid.

type UpdateAppInstanceUserEndpointOutput added in v1.41.11

type UpdateAppInstanceUserEndpointOutput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserEndpointOutput's
	// String and GoString methods.
	AppInstanceUserArn *string `min:"5" type:"string" sensitive:"true"`

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserEndpointOutput's
	// String and GoString methods.
	EndpointId *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateAppInstanceUserEndpointOutput) GoString added in v1.41.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceUserEndpointOutput) SetAppInstanceUserArn added in v1.41.11

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*UpdateAppInstanceUserEndpointOutput) SetEndpointId added in v1.41.11

SetEndpointId sets the EndpointId field's value.

func (UpdateAppInstanceUserEndpointOutput) String added in v1.41.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAppInstanceUserInput

type UpdateAppInstanceUserInput struct {

	// The ARN of the AppInstanceUser.
	//
	// AppInstanceUserArn is a required field
	AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true"`

	// The metadata of the AppInstanceUser.
	//
	// Metadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserInput's
	// String and GoString methods.
	//
	// Metadata is a required field
	Metadata *string `type:"string" required:"true" sensitive:"true"`

	// The name of the AppInstanceUser.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAppInstanceUserInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateAppInstanceUserInput) GoString

func (s UpdateAppInstanceUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceUserInput) SetAppInstanceUserArn

func (s *UpdateAppInstanceUserInput) SetAppInstanceUserArn(v string) *UpdateAppInstanceUserInput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (*UpdateAppInstanceUserInput) SetMetadata

SetMetadata sets the Metadata field's value.

func (*UpdateAppInstanceUserInput) SetName

SetName sets the Name field's value.

func (UpdateAppInstanceUserInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceUserInput) Validate

func (s *UpdateAppInstanceUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAppInstanceUserOutput

type UpdateAppInstanceUserOutput struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAppInstanceUserOutput) GoString

func (s UpdateAppInstanceUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppInstanceUserOutput) SetAppInstanceUserArn

func (s *UpdateAppInstanceUserOutput) SetAppInstanceUserArn(v string) *UpdateAppInstanceUserOutput

SetAppInstanceUserArn sets the AppInstanceUserArn field's value.

func (UpdateAppInstanceUserOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package chimesdkidentityiface provides an interface to enable mocking the Amazon Chime SDK Identity service client for testing your code.
Package chimesdkidentityiface provides an interface to enable mocking the Amazon Chime SDK Identity service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL