chime

package
v1.16.9-custom-go-mod Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package chime provides the client and types for making API requests to Amazon Chime.

The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDKYou don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center (http://aws.amazon.com/developer/).

Using the AWS CLIUse your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface (http://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands (http://docs.aws.amazon.com/cli/latest/reference/chime/index.html) in the AWS CLI Command Reference.

Using REST APIIf you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console (http://docs.aws.amazon.com/chime/latest/ag/control-access.html) in the Amazon Chime Administration Guide.

See https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01 for more information on this service.

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

Using the Client

To contact Amazon Chime 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 client Chime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/chime/#New

Index

Constants

View Source 
const (
	// AccountTypeTeam is a AccountType enum value
	AccountTypeTeam = "Team"

	// AccountTypeEnterpriseDirectory is a AccountType enum value
	AccountTypeEnterpriseDirectory = "EnterpriseDirectory"

	// AccountTypeEnterpriseLwa is a AccountType enum value
	AccountTypeEnterpriseLwa = "EnterpriseLWA"

	// AccountTypeEnterpriseOidc is a AccountType enum value
	AccountTypeEnterpriseOidc = "EnterpriseOIDC"
)
View Source 
const (
	// EmailStatusNotSent is a EmailStatus enum value
	EmailStatusNotSent = "NotSent"

	// EmailStatusSent is a EmailStatus enum value
	EmailStatusSent = "Sent"

	// EmailStatusFailed is a EmailStatus enum value
	EmailStatusFailed = "Failed"
)
View Source 
const (
	// ErrorCodeUnauthorized is a ErrorCode enum value
	ErrorCodeUnauthorized = "Unauthorized"

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

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

	// ErrorCodeBadRequest is a ErrorCode enum value
	ErrorCodeBadRequest = "BadRequest"

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

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

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

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

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

	// ErrorCodePreconditionFailed is a ErrorCode enum value
	ErrorCodePreconditionFailed = "PreconditionFailed"
)
View Source 
const (
	// InviteStatusPending is a InviteStatus enum value
	InviteStatusPending = "Pending"

	// InviteStatusAccepted is a InviteStatus enum value
	InviteStatusAccepted = "Accepted"

	// InviteStatusFailed is a InviteStatus enum value
	InviteStatusFailed = "Failed"
)
View Source 
const (
	// LicenseBasic is a License enum value
	LicenseBasic = "Basic"

	// LicensePlus is a License enum value
	LicensePlus = "Plus"

	// LicensePro is a License enum value
	LicensePro = "Pro"

	// LicenseProTrial is a License enum value
	LicenseProTrial = "ProTrial"
)
View Source 
const (
	// RegistrationStatusUnregistered is a RegistrationStatus enum value
	RegistrationStatusUnregistered = "Unregistered"

	// RegistrationStatusRegistered is a RegistrationStatus enum value
	RegistrationStatusRegistered = "Registered"

	// RegistrationStatusSuspended is a RegistrationStatus enum value
	RegistrationStatusSuspended = "Suspended"
)
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. For example,
	// when a user tries to create an account from an unsupported region.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// One or more of the resources in the request does not exist in the system.
	ErrCodeNotFoundException = "NotFoundException"

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

	// ErrCodeUnprocessableEntityException for service response error code
	// "UnprocessableEntityException".
	//
	// The request was well-formed but was unable to be followed due to semantic
	// errors.
	ErrCodeUnprocessableEntityException = "UnprocessableEntityException"
)
View Source 
const (
	ServiceName = "Chime" // Name of service.
	EndpointsID = "chime" // ID to lookup a service endpoint with.
	ServiceID   = "Chime" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `type:"string" required:"true"`

	// The Amazon Chime account type. For more information about different account
	// types, see Managing Your Amazon Chime Accounts (http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html)
	// in the Amazon Chime Administration Guide.
	AccountType *string `type:"string" enum:"AccountType"`

	// The AWS account ID.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `type:"string" required:"true"`

	// The Amazon Chime account creation timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The default license for the Amazon Chime account.
	DefaultLicense *string `type:"string" enum:"License"`

	// The Amazon Chime account name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Supported licenses for the Amazon Chime account.
	SupportedLicenses []*string `type:"list"`
	// contains filtered or unexported fields
}

The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

func (Account) GoString 

func (s Account) GoString() string

GoString returns the string representation

func (*Account) SetAccountId 

func (s *Account) SetAccountId(v string) *Account

SetAccountId sets the AccountId field's value.

func (*Account) SetAccountType 

func (s *Account) SetAccountType(v string) *Account

SetAccountType sets the AccountType field's value.

func (*Account) SetAwsAccountId 

func (s *Account) SetAwsAccountId(v string) *Account

SetAwsAccountId sets the AwsAccountId field's value.

func (*Account) SetCreatedTimestamp 

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

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*Account) SetDefaultLicense 

func (s *Account) SetDefaultLicense(v string) *Account

SetDefaultLicense sets the DefaultLicense field's value.

func (*Account) SetName 

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

SetName sets the Name field's value.

func (*Account) SetSupportedLicenses 

func (s *Account) SetSupportedLicenses(v []*string) *Account

SetSupportedLicenses sets the SupportedLicenses field's value.

func (Account) String 

func (s Account) String() string

String returns the string representation

type AccountSettings 

type AccountSettings struct {

	// Setting that stops or starts remote control of shared screens during meetings.
	DisableRemoteControl *bool `type:"boolean"`

	// Setting that allows meeting participants to choose the Call me at a phone
	// number option. For more information, see Join a Meeting without the Amazon
	// Chime App (http://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html).
	EnableDialOut *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page (http://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

func (AccountSettings) GoString 

func (s AccountSettings) GoString() string

GoString returns the string representation

func (*AccountSettings) SetDisableRemoteControl 

func (s *AccountSettings) SetDisableRemoteControl(v bool) *AccountSettings

SetDisableRemoteControl sets the DisableRemoteControl field's value.

func (*AccountSettings) SetEnableDialOut 

func (s *AccountSettings) SetEnableDialOut(v bool) *AccountSettings

SetEnableDialOut sets the EnableDialOut field's value.

func (AccountSettings) String 

func (s AccountSettings) String() string

String returns the string representation

type BatchSuspendUserInput 

type BatchSuspendUserInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The request containing the user IDs to suspend.
	//
	// UserIdList is a required field
	UserIdList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchSuspendUserInput) GoString 

func (s BatchSuspendUserInput) GoString() string

GoString returns the string representation

func (*BatchSuspendUserInput) SetAccountId 

func (s *BatchSuspendUserInput) SetAccountId(v string) *BatchSuspendUserInput

SetAccountId sets the AccountId field's value.

func (*BatchSuspendUserInput) SetUserIdList 

func (s *BatchSuspendUserInput) SetUserIdList(v []*string) *BatchSuspendUserInput

SetUserIdList sets the UserIdList field's value.

func (BatchSuspendUserInput) String 

func (s BatchSuspendUserInput) String() string

String returns the string representation

func (*BatchSuspendUserInput) Validate 

func (s *BatchSuspendUserInput) Validate() error

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

type BatchSuspendUserOutput 

type BatchSuspendUserOutput struct {

	// If the BatchSuspendUser action fails for one or more of the user IDs in the
	// request, a list of the user IDs is returned, along with error codes and error
	// messages.
	UserErrors []*UserError `type:"list"`
	// contains filtered or unexported fields
}

func (BatchSuspendUserOutput) GoString 

func (s BatchSuspendUserOutput) GoString() string

GoString returns the string representation

func (*BatchSuspendUserOutput) SetUserErrors 

func (s *BatchSuspendUserOutput) SetUserErrors(v []*UserError) *BatchSuspendUserOutput

SetUserErrors sets the UserErrors field's value.

func (BatchSuspendUserOutput) String 

func (s BatchSuspendUserOutput) String() string

String returns the string representation

type BatchUnsuspendUserInput 

type BatchUnsuspendUserInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The request containing the user IDs to unsuspend.
	//
	// UserIdList is a required field
	UserIdList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUnsuspendUserInput) GoString 

func (s BatchUnsuspendUserInput) GoString() string

GoString returns the string representation

func (*BatchUnsuspendUserInput) SetAccountId 

func (s *BatchUnsuspendUserInput) SetAccountId(v string) *BatchUnsuspendUserInput

SetAccountId sets the AccountId field's value.

func (*BatchUnsuspendUserInput) SetUserIdList 

func (s *BatchUnsuspendUserInput) SetUserIdList(v []*string) *BatchUnsuspendUserInput

SetUserIdList sets the UserIdList field's value.

func (BatchUnsuspendUserInput) String 

func (s BatchUnsuspendUserInput) String() string

String returns the string representation

func (*BatchUnsuspendUserInput) Validate 

func (s *BatchUnsuspendUserInput) Validate() error

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

type BatchUnsuspendUserOutput 

type BatchUnsuspendUserOutput struct {

	// If the BatchUnsuspendUser action fails for one or more of the user IDs in
	// the request, a list of the user IDs is returned, along with error codes and
	// error messages.
	UserErrors []*UserError `type:"list"`
	// contains filtered or unexported fields
}

func (BatchUnsuspendUserOutput) GoString 

func (s BatchUnsuspendUserOutput) GoString() string

GoString returns the string representation

func (*BatchUnsuspendUserOutput) SetUserErrors 

func (s *BatchUnsuspendUserOutput) SetUserErrors(v []*UserError) *BatchUnsuspendUserOutput

SetUserErrors sets the UserErrors field's value.

func (BatchUnsuspendUserOutput) String 

func (s BatchUnsuspendUserOutput) String() string

String returns the string representation

type BatchUpdateUserInput 

type BatchUpdateUserInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The request containing the user IDs and details to update.
	//
	// UpdateUserRequestItems is a required field
	UpdateUserRequestItems []*UpdateUserRequestItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateUserInput) GoString 

func (s BatchUpdateUserInput) GoString() string

GoString returns the string representation

func (*BatchUpdateUserInput) SetAccountId 

func (s *BatchUpdateUserInput) SetAccountId(v string) *BatchUpdateUserInput

SetAccountId sets the AccountId field's value.

func (*BatchUpdateUserInput) SetUpdateUserRequestItems 

func (s *BatchUpdateUserInput) SetUpdateUserRequestItems(v []*UpdateUserRequestItem) *BatchUpdateUserInput

SetUpdateUserRequestItems sets the UpdateUserRequestItems field's value.

func (BatchUpdateUserInput) String 

func (s BatchUpdateUserInput) String() string

String returns the string representation

func (*BatchUpdateUserInput) Validate 

func (s *BatchUpdateUserInput) Validate() error

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

type BatchUpdateUserOutput 

type BatchUpdateUserOutput struct {

	// If the BatchUpdateUser action fails for one or more of the user IDs in the
	// request, a list of the user IDs is returned, along with error codes and error
	// messages.
	UserErrors []*UserError `type:"list"`
	// contains filtered or unexported fields
}

func (BatchUpdateUserOutput) GoString 

func (s BatchUpdateUserOutput) GoString() string

GoString returns the string representation

func (*BatchUpdateUserOutput) SetUserErrors 

func (s *BatchUpdateUserOutput) SetUserErrors(v []*UserError) *BatchUpdateUserOutput

SetUserErrors sets the UserErrors field's value.

func (BatchUpdateUserOutput) String 

func (s BatchUpdateUserOutput) String() string

String returns the string representation

type Chime 

type Chime struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Chime

New creates a new instance of the Chime 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: 

// Create a Chime client from just a session.
svc := chime.New(mySession)

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

func (*Chime) BatchSuspendUser 

func (c *Chime) BatchSuspendUser(input *BatchSuspendUserInput) (*BatchSuspendUserOutput, error)

BatchSuspendUser API operation for Amazon Chime.

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts (http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

Users suspended from a Team account are dissociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and are no longer able to sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

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's API operation BatchSuspendUser for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUser

func (*Chime) BatchSuspendUserRequest 

func (c *Chime) BatchSuspendUserRequest(input *BatchSuspendUserInput) (req *request.Request, output *BatchSuspendUserOutput)

BatchSuspendUserRequest generates a "aws/request.Request" representing the client's request for the BatchSuspendUser 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 BatchSuspendUser for more information on using the BatchSuspendUser 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 BatchSuspendUserRequest method.
req, resp := client.BatchSuspendUserRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUser

func (*Chime) BatchSuspendUserWithContext 

func (c *Chime) BatchSuspendUserWithContext(ctx aws.Context, input *BatchSuspendUserInput, opts ...request.Option) (*BatchSuspendUserOutput, error)

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

See BatchSuspendUser 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 (*Chime) BatchUnsuspendUser 

func (c *Chime) BatchUnsuspendUser(input *BatchUnsuspendUserInput) (*BatchUnsuspendUserOutput, error)

BatchUnsuspendUser API operation for Amazon Chime.

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts (http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

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's API operation BatchUnsuspendUser for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUser

func (*Chime) BatchUnsuspendUserRequest 

func (c *Chime) BatchUnsuspendUserRequest(input *BatchUnsuspendUserInput) (req *request.Request, output *BatchUnsuspendUserOutput)

BatchUnsuspendUserRequest generates a "aws/request.Request" representing the client's request for the BatchUnsuspendUser 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 BatchUnsuspendUser for more information on using the BatchUnsuspendUser 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 BatchUnsuspendUserRequest method.
req, resp := client.BatchUnsuspendUserRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUser

func (*Chime) BatchUnsuspendUserWithContext 

func (c *Chime) BatchUnsuspendUserWithContext(ctx aws.Context, input *BatchUnsuspendUserInput, opts ...request.Option) (*BatchUnsuspendUserOutput, error)

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

See BatchUnsuspendUser 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 (*Chime) BatchUpdateUser 

func (c *Chime) BatchUpdateUser(input *BatchUpdateUserInput) (*BatchUpdateUserOutput, error)

BatchUpdateUser API operation for Amazon Chime.

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

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's API operation BatchUpdateUser for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUser

func (*Chime) BatchUpdateUserRequest 

func (c *Chime) BatchUpdateUserRequest(input *BatchUpdateUserInput) (req *request.Request, output *BatchUpdateUserOutput)

BatchUpdateUserRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateUser 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 BatchUpdateUser for more information on using the BatchUpdateUser 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 BatchUpdateUserRequest method.
req, resp := client.BatchUpdateUserRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUser

func (*Chime) BatchUpdateUserWithContext 

func (c *Chime) BatchUpdateUserWithContext(ctx aws.Context, input *BatchUpdateUserInput, opts ...request.Option) (*BatchUpdateUserOutput, error)

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

See BatchUpdateUser 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 (*Chime) CreateAccount 

func (c *Chime) CreateAccount(input *CreateAccountInput) (*CreateAccountOutput, error)

CreateAccount API operation for Amazon Chime.

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts (http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

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's API operation CreateAccount for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccount

func (*Chime) CreateAccountRequest 

func (c *Chime) CreateAccountRequest(input *CreateAccountInput) (req *request.Request, output *CreateAccountOutput)

CreateAccountRequest generates a "aws/request.Request" representing the client's request for the CreateAccount 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 CreateAccount for more information on using the CreateAccount 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 CreateAccountRequest method.
req, resp := client.CreateAccountRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccount

func (*Chime) CreateAccountWithContext 

func (c *Chime) CreateAccountWithContext(ctx aws.Context, input *CreateAccountInput, opts ...request.Option) (*CreateAccountOutput, error)

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

See CreateAccount 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 (*Chime) DeleteAccount 

func (c *Chime) DeleteAccount(input *DeleteAccountInput) (*DeleteAccountOutput, error)

DeleteAccount API operation for Amazon Chime.

Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

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's API operation DeleteAccount for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeUnprocessableEntityException "UnprocessableEntityException" The request was well-formed but was unable to be followed due to semantic errors.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccount

func (*Chime) DeleteAccountRequest 

func (c *Chime) DeleteAccountRequest(input *DeleteAccountInput) (req *request.Request, output *DeleteAccountOutput)

DeleteAccountRequest generates a "aws/request.Request" representing the client's request for the DeleteAccount 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 DeleteAccount for more information on using the DeleteAccount 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 DeleteAccountRequest method.
req, resp := client.DeleteAccountRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccount

func (*Chime) DeleteAccountWithContext 

func (c *Chime) DeleteAccountWithContext(ctx aws.Context, input *DeleteAccountInput, opts ...request.Option) (*DeleteAccountOutput, error)

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

See DeleteAccount 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 (*Chime) GetAccount 

func (c *Chime) GetAccount(input *GetAccountInput) (*GetAccountOutput, error)

GetAccount API operation for Amazon Chime.

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

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's API operation GetAccount for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccount

func (*Chime) GetAccountRequest 

func (c *Chime) GetAccountRequest(input *GetAccountInput) (req *request.Request, output *GetAccountOutput)

GetAccountRequest generates a "aws/request.Request" representing the client's request for the GetAccount 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 GetAccount for more information on using the GetAccount 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 GetAccountRequest method.
req, resp := client.GetAccountRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccount

func (*Chime) GetAccountSettings 

func (c *Chime) GetAccountSettings(input *GetAccountSettingsInput) (*GetAccountSettingsOutput, error)

GetAccountSettings API operation for Amazon Chime.

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page (http://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

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's API operation GetAccountSettings for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

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

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettings

func (*Chime) GetAccountSettingsRequest 

func (c *Chime) GetAccountSettingsRequest(input *GetAccountSettingsInput) (req *request.Request, output *GetAccountSettingsOutput)

GetAccountSettingsRequest generates a "aws/request.Request" representing the client's request for the GetAccountSettings 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 GetAccountSettings for more information on using the GetAccountSettings 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 GetAccountSettingsRequest method.
req, resp := client.GetAccountSettingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettings

func (*Chime) GetAccountSettingsWithContext 

func (c *Chime) GetAccountSettingsWithContext(ctx aws.Context, input *GetAccountSettingsInput, opts ...request.Option) (*GetAccountSettingsOutput, error)

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

See GetAccountSettings 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 (*Chime) GetAccountWithContext 

func (c *Chime) GetAccountWithContext(ctx aws.Context, input *GetAccountInput, opts ...request.Option) (*GetAccountOutput, error)

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

See GetAccount 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 (*Chime) GetUser 

func (c *Chime) GetUser(input *GetUserInput) (*GetUserOutput, error)

GetUser API operation for Amazon Chime.

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

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's API operation GetUser for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUser

func (*Chime) GetUserRequest 

func (c *Chime) GetUserRequest(input *GetUserInput) (req *request.Request, output *GetUserOutput)

GetUserRequest generates a "aws/request.Request" representing the client's request for the GetUser 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 GetUser for more information on using the GetUser 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 GetUserRequest method.
req, resp := client.GetUserRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUser

func (*Chime) GetUserWithContext 

func (c *Chime) GetUserWithContext(ctx aws.Context, input *GetUserInput, opts ...request.Option) (*GetUserOutput, error)

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

See GetUser 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 (*Chime) InviteUsers 

func (c *Chime) InviteUsers(input *InviteUsersInput) (*InviteUsersOutput, error)

InviteUsers API operation for Amazon Chime.

Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

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's API operation InviteUsers for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsers

func (*Chime) InviteUsersRequest 

func (c *Chime) InviteUsersRequest(input *InviteUsersInput) (req *request.Request, output *InviteUsersOutput)

InviteUsersRequest generates a "aws/request.Request" representing the client's request for the InviteUsers 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 InviteUsers for more information on using the InviteUsers 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 InviteUsersRequest method.
req, resp := client.InviteUsersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsers

func (*Chime) InviteUsersWithContext 

func (c *Chime) InviteUsersWithContext(ctx aws.Context, input *InviteUsersInput, opts ...request.Option) (*InviteUsersOutput, error)

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

See InviteUsers 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 (*Chime) ListAccounts 

func (c *Chime) ListAccounts(input *ListAccountsInput) (*ListAccountsOutput, error)

ListAccounts API operation for Amazon Chime.

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

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's API operation ListAccounts for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccounts

func (*Chime) ListAccountsPages 

func (c *Chime) ListAccountsPages(input *ListAccountsInput, fn func(*ListAccountsOutput, bool) bool) error

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

See ListAccounts 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 ListAccounts operation.
pageNum := 0
err := client.ListAccountsPages(params,
    func(page *ListAccountsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Chime) ListAccountsPagesWithContext 

func (c *Chime) ListAccountsPagesWithContext(ctx aws.Context, input *ListAccountsInput, fn func(*ListAccountsOutput, bool) bool, opts ...request.Option) error

ListAccountsPagesWithContext same as ListAccountsPages 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 (*Chime) ListAccountsRequest 

func (c *Chime) ListAccountsRequest(input *ListAccountsInput) (req *request.Request, output *ListAccountsOutput)

ListAccountsRequest generates a "aws/request.Request" representing the client's request for the ListAccounts 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 ListAccounts for more information on using the ListAccounts 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 ListAccountsRequest method.
req, resp := client.ListAccountsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccounts

func (*Chime) ListAccountsWithContext 

func (c *Chime) ListAccountsWithContext(ctx aws.Context, input *ListAccountsInput, opts ...request.Option) (*ListAccountsOutput, error)

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

See ListAccounts 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 (*Chime) ListUsers 

func (c *Chime) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for Amazon Chime.

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

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's API operation ListUsers for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsers

func (*Chime) ListUsersPages 

func (c *Chime) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error

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

See ListUsers 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 ListUsers operation.
pageNum := 0
err := client.ListUsersPages(params,
    func(page *ListUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Chime) ListUsersPagesWithContext 

func (c *Chime) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error

ListUsersPagesWithContext same as ListUsersPages 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 (*Chime) ListUsersRequest 

func (c *Chime) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers 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 ListUsers for more information on using the ListUsers 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 ListUsersRequest method.
req, resp := client.ListUsersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsers

func (*Chime) ListUsersWithContext 

func (c *Chime) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

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

See ListUsers 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 (*Chime) LogoutUser 

func (c *Chime) LogoutUser(input *LogoutUserInput) (*LogoutUserOutput, error)

LogoutUser API operation for Amazon Chime.

Logs out the specified user from all of the devices they are currently logged into.

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's API operation LogoutUser for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUser

func (*Chime) LogoutUserRequest 

func (c *Chime) LogoutUserRequest(input *LogoutUserInput) (req *request.Request, output *LogoutUserOutput)

LogoutUserRequest generates a "aws/request.Request" representing the client's request for the LogoutUser 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 LogoutUser for more information on using the LogoutUser 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 LogoutUserRequest method.
req, resp := client.LogoutUserRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUser

func (*Chime) LogoutUserWithContext 

func (c *Chime) LogoutUserWithContext(ctx aws.Context, input *LogoutUserInput, opts ...request.Option) (*LogoutUserOutput, error)

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

See LogoutUser 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 (*Chime) ResetPersonalPIN 

func (c *Chime) ResetPersonalPIN(input *ResetPersonalPINInput) (*ResetPersonalPINOutput, error)

ResetPersonalPIN API operation for Amazon Chime.

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

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's API operation ResetPersonalPIN for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPIN

func (*Chime) ResetPersonalPINRequest 

func (c *Chime) ResetPersonalPINRequest(input *ResetPersonalPINInput) (req *request.Request, output *ResetPersonalPINOutput)

ResetPersonalPINRequest generates a "aws/request.Request" representing the client's request for the ResetPersonalPIN 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 ResetPersonalPIN for more information on using the ResetPersonalPIN 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 ResetPersonalPINRequest method.
req, resp := client.ResetPersonalPINRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPIN

func (*Chime) ResetPersonalPINWithContext 

func (c *Chime) ResetPersonalPINWithContext(ctx aws.Context, input *ResetPersonalPINInput, opts ...request.Option) (*ResetPersonalPINOutput, error)

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

See ResetPersonalPIN 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 (*Chime) UpdateAccount 

func (c *Chime) UpdateAccount(input *UpdateAccountInput) (*UpdateAccountOutput, error)

UpdateAccount API operation for Amazon Chime.

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

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's API operation UpdateAccount for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccount

func (*Chime) UpdateAccountRequest 

func (c *Chime) UpdateAccountRequest(input *UpdateAccountInput) (req *request.Request, output *UpdateAccountOutput)

UpdateAccountRequest generates a "aws/request.Request" representing the client's request for the UpdateAccount 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 UpdateAccount for more information on using the UpdateAccount 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 UpdateAccountRequest method.
req, resp := client.UpdateAccountRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccount

func (*Chime) UpdateAccountSettings 

func (c *Chime) UpdateAccountSettings(input *UpdateAccountSettingsInput) (*UpdateAccountSettingsOutput, error)

UpdateAccountSettings API operation for Amazon Chime.

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page (http://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

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's API operation UpdateAccountSettings for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

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

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettings

func (*Chime) UpdateAccountSettingsRequest 

func (c *Chime) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) (req *request.Request, output *UpdateAccountSettingsOutput)

UpdateAccountSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateAccountSettings 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 UpdateAccountSettings for more information on using the UpdateAccountSettings 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 UpdateAccountSettingsRequest method.
req, resp := client.UpdateAccountSettingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettings

func (*Chime) UpdateAccountSettingsWithContext 

func (c *Chime) UpdateAccountSettingsWithContext(ctx aws.Context, input *UpdateAccountSettingsInput, opts ...request.Option) (*UpdateAccountSettingsOutput, error)

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

See UpdateAccountSettings 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 (*Chime) UpdateAccountWithContext 

func (c *Chime) UpdateAccountWithContext(ctx aws.Context, input *UpdateAccountInput, opts ...request.Option) (*UpdateAccountOutput, error)

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

See UpdateAccount 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 (*Chime) UpdateUser 

func (c *Chime) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for Amazon Chime.

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

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's API operation UpdateUser for usage and error information.

Returned Error Codes:

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

  • ErrCodeNotFoundException "NotFoundException" One or more of the resources in the request does not exist in the system.

  • ErrCodeForbiddenException "ForbiddenException" The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

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

  • ErrCodeThrottledClientException "ThrottledClientException" The client exceeded its request rate limit.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service is currently unavailable.

  • ErrCodeServiceFailureException "ServiceFailureException" The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUser

func (*Chime) UpdateUserRequest 

func (c *Chime) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser 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 UpdateUser for more information on using the UpdateUser 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 UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUser

func (*Chime) UpdateUserWithContext 

func (c *Chime) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

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

See UpdateUser 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 CreateAccountInput 

type CreateAccountInput struct {

	// The name of the Amazon Chime account.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAccountInput) GoString 

func (s CreateAccountInput) GoString() string

GoString returns the string representation

func (*CreateAccountInput) SetName 

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

SetName sets the Name field's value.

func (CreateAccountInput) String 

func (s CreateAccountInput) String() string

String returns the string representation

func (*CreateAccountInput) Validate 

func (s *CreateAccountInput) Validate() error

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

type CreateAccountOutput 

type CreateAccountOutput struct {

	// The Amazon Chime account details.
	Account *Account `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAccountOutput) GoString 

func (s CreateAccountOutput) GoString() string

GoString returns the string representation

func (*CreateAccountOutput) SetAccount 

func (s *CreateAccountOutput) SetAccount(v *Account) *CreateAccountOutput

SetAccount sets the Account field's value.

func (CreateAccountOutput) String 

func (s CreateAccountOutput) String() string

String returns the string representation

type DeleteAccountInput 

type DeleteAccountInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccountInput) GoString 

func (s DeleteAccountInput) GoString() string

GoString returns the string representation

func (*DeleteAccountInput) SetAccountId 

func (s *DeleteAccountInput) SetAccountId(v string) *DeleteAccountInput

SetAccountId sets the AccountId field's value.

func (DeleteAccountInput) String 

func (s DeleteAccountInput) String() string

String returns the string representation

func (*DeleteAccountInput) Validate 

func (s *DeleteAccountInput) Validate() error

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

type DeleteAccountOutput 

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

func (DeleteAccountOutput) GoString 

func (s DeleteAccountOutput) GoString() string

GoString returns the string representation

func (DeleteAccountOutput) String 

func (s DeleteAccountOutput) String() string

String returns the string representation

type GetAccountInput 

type GetAccountInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccountInput) GoString 

func (s GetAccountInput) GoString() string

GoString returns the string representation

func (*GetAccountInput) SetAccountId 

func (s *GetAccountInput) SetAccountId(v string) *GetAccountInput

SetAccountId sets the AccountId field's value.

func (GetAccountInput) String 

func (s GetAccountInput) String() string

String returns the string representation

func (*GetAccountInput) Validate 

func (s *GetAccountInput) Validate() error

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

type GetAccountOutput 

type GetAccountOutput struct {

	// The Amazon Chime account details.
	Account *Account `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccountOutput) GoString 

func (s GetAccountOutput) GoString() string

GoString returns the string representation

func (*GetAccountOutput) SetAccount 

func (s *GetAccountOutput) SetAccount(v *Account) *GetAccountOutput

SetAccount sets the Account field's value.

func (GetAccountOutput) String 

func (s GetAccountOutput) String() string

String returns the string representation

type GetAccountSettingsInput 

type GetAccountSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccountSettingsInput) GoString 

func (s GetAccountSettingsInput) GoString() string

GoString returns the string representation

func (*GetAccountSettingsInput) SetAccountId 

func (s *GetAccountSettingsInput) SetAccountId(v string) *GetAccountSettingsInput

SetAccountId sets the AccountId field's value.

func (GetAccountSettingsInput) String 

func (s GetAccountSettingsInput) String() string

String returns the string representation

func (*GetAccountSettingsInput) Validate 

func (s *GetAccountSettingsInput) Validate() error

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

type GetAccountSettingsOutput 

type GetAccountSettingsOutput struct {

	// The Amazon Chime account settings.
	AccountSettings *AccountSettings `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccountSettingsOutput) GoString 

func (s GetAccountSettingsOutput) GoString() string

GoString returns the string representation

func (*GetAccountSettingsOutput) SetAccountSettings 

func (s *GetAccountSettingsOutput) SetAccountSettings(v *AccountSettings) *GetAccountSettingsOutput

SetAccountSettings sets the AccountSettings field's value.

func (GetAccountSettingsOutput) String 

func (s GetAccountSettingsOutput) String() string

String returns the string representation

type GetUserInput 

type GetUserInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetUserInput) GoString 

func (s GetUserInput) GoString() string

GoString returns the string representation

func (*GetUserInput) SetAccountId 

func (s *GetUserInput) SetAccountId(v string) *GetUserInput

SetAccountId sets the AccountId field's value.

func (*GetUserInput) SetUserId 

func (s *GetUserInput) SetUserId(v string) *GetUserInput

SetUserId sets the UserId field's value.

func (GetUserInput) String 

func (s GetUserInput) String() string

String returns the string representation

func (*GetUserInput) Validate 

func (s *GetUserInput) Validate() error

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

type GetUserOutput 

type GetUserOutput struct {

	// The user details.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (GetUserOutput) GoString 

func (s GetUserOutput) GoString() string

GoString returns the string representation

func (*GetUserOutput) SetUser 

func (s *GetUserOutput) SetUser(v *User) *GetUserOutput

SetUser sets the User field's value.

func (GetUserOutput) String 

func (s GetUserOutput) String() string

String returns the string representation

type Invite 

type Invite struct {

	// The email address to which the invite is sent.
	EmailAddress *string `type:"string" sensitive:"true"`

	// The status of the invite email.
	EmailStatus *string `type:"string" enum:"EmailStatus"`

	// The invite ID.
	InviteId *string `type:"string"`

	// The status of the invite.
	Status *string `type:"string" enum:"InviteStatus"`
	// contains filtered or unexported fields
}

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

func (Invite) GoString 

func (s Invite) GoString() string

GoString returns the string representation

func (*Invite) SetEmailAddress 

func (s *Invite) SetEmailAddress(v string) *Invite

SetEmailAddress sets the EmailAddress field's value.

func (*Invite) SetEmailStatus 

func (s *Invite) SetEmailStatus(v string) *Invite

SetEmailStatus sets the EmailStatus field's value.

func (*Invite) SetInviteId 

func (s *Invite) SetInviteId(v string) *Invite

SetInviteId sets the InviteId field's value.

func (*Invite) SetStatus 

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

SetStatus sets the Status field's value.

func (Invite) String 

func (s Invite) String() string

String returns the string representation

type InviteUsersInput 

type InviteUsersInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The user email addresses to which to send the invite.
	//
	// UserEmailList is a required field
	UserEmailList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (InviteUsersInput) GoString 

func (s InviteUsersInput) GoString() string

GoString returns the string representation

func (*InviteUsersInput) SetAccountId 

func (s *InviteUsersInput) SetAccountId(v string) *InviteUsersInput

SetAccountId sets the AccountId field's value.

func (*InviteUsersInput) SetUserEmailList 

func (s *InviteUsersInput) SetUserEmailList(v []*string) *InviteUsersInput

SetUserEmailList sets the UserEmailList field's value.

func (InviteUsersInput) String 

func (s InviteUsersInput) String() string

String returns the string representation

func (*InviteUsersInput) Validate 

func (s *InviteUsersInput) Validate() error

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

type InviteUsersOutput 

type InviteUsersOutput struct {

	// The invite details.
	Invites []*Invite `type:"list"`
	// contains filtered or unexported fields
}

func (InviteUsersOutput) GoString 

func (s InviteUsersOutput) GoString() string

GoString returns the string representation

func (*InviteUsersOutput) SetInvites 

func (s *InviteUsersOutput) SetInvites(v []*Invite) *InviteUsersOutput

SetInvites sets the Invites field's value.

func (InviteUsersOutput) String 

func (s InviteUsersOutput) String() string

String returns the string representation

type ListAccountsInput 

type ListAccountsInput struct {

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// Amazon Chime account name prefix with which to filter results.
	Name *string `location:"querystring" locationName:"name" min:"1" type:"string"`

	// The token to use to retrieve the next page of results.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	// User email address with which to filter results.
	UserEmail *string `location:"querystring" locationName:"user-email" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListAccountsInput) GoString 

func (s ListAccountsInput) GoString() string

GoString returns the string representation

func (*ListAccountsInput) SetMaxResults 

func (s *ListAccountsInput) SetMaxResults(v int64) *ListAccountsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAccountsInput) SetName 

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

SetName sets the Name field's value.

func (*ListAccountsInput) SetNextToken 

func (s *ListAccountsInput) SetNextToken(v string) *ListAccountsInput

SetNextToken sets the NextToken field's value.

func (*ListAccountsInput) SetUserEmail 

func (s *ListAccountsInput) SetUserEmail(v string) *ListAccountsInput

SetUserEmail sets the UserEmail field's value.

func (ListAccountsInput) String 

func (s ListAccountsInput) String() string

String returns the string representation

func (*ListAccountsInput) Validate 

func (s *ListAccountsInput) Validate() error

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

type ListAccountsOutput 

type ListAccountsOutput struct {

	// List of Amazon Chime accounts and account details.
	Accounts []*Account `type:"list"`

	// The token to use to retrieve the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAccountsOutput) GoString 

func (s ListAccountsOutput) GoString() string

GoString returns the string representation

func (*ListAccountsOutput) SetAccounts 

func (s *ListAccountsOutput) SetAccounts(v []*Account) *ListAccountsOutput

SetAccounts sets the Accounts field's value.

func (*ListAccountsOutput) SetNextToken 

func (s *ListAccountsOutput) SetNextToken(v string) *ListAccountsOutput

SetNextToken sets the NextToken field's value.

func (ListAccountsOutput) String 

func (s ListAccountsOutput) String() string

String returns the string representation

type ListUsersInput 

type ListUsersInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token to use to retrieve the next page of results.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	// Optional. The user email address used to filter results. Maximum 1.
	UserEmail *string `location:"querystring" locationName:"user-email" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListUsersInput) GoString 

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetAccountId 

func (s *ListUsersInput) SetAccountId(v string) *ListUsersInput

SetAccountId sets the AccountId field's value.

func (*ListUsersInput) SetMaxResults 

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken 

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (*ListUsersInput) SetUserEmail 

func (s *ListUsersInput) SetUserEmail(v string) *ListUsersInput

SetUserEmail sets the UserEmail field's value.

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate 

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput 

type ListUsersOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string `type:"string"`

	// List of users and user details.
	Users []*User `type:"list"`
	// contains filtered or unexported fields
}

func (ListUsersOutput) GoString 

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken 

func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetUsers 

func (s *ListUsersOutput) SetUsers(v []*User) *ListUsersOutput

SetUsers sets the Users field's value.

func (ListUsersOutput) String 

func (s ListUsersOutput) String() string

String returns the string representation

type LogoutUserInput 

type LogoutUserInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (LogoutUserInput) GoString 

func (s LogoutUserInput) GoString() string

GoString returns the string representation

func (*LogoutUserInput) SetAccountId 

func (s *LogoutUserInput) SetAccountId(v string) *LogoutUserInput

SetAccountId sets the AccountId field's value.

func (*LogoutUserInput) SetUserId 

func (s *LogoutUserInput) SetUserId(v string) *LogoutUserInput

SetUserId sets the UserId field's value.

func (LogoutUserInput) String 

func (s LogoutUserInput) String() string

String returns the string representation

func (*LogoutUserInput) Validate 

func (s *LogoutUserInput) Validate() error

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

type LogoutUserOutput 

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

func (LogoutUserOutput) GoString 

func (s LogoutUserOutput) GoString() string

GoString returns the string representation

func (LogoutUserOutput) String 

func (s LogoutUserOutput) String() string

String returns the string representation

type ResetPersonalPINInput 

type ResetPersonalPINInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResetPersonalPINInput) GoString 

func (s ResetPersonalPINInput) GoString() string

GoString returns the string representation

func (*ResetPersonalPINInput) SetAccountId 

func (s *ResetPersonalPINInput) SetAccountId(v string) *ResetPersonalPINInput

SetAccountId sets the AccountId field's value.

func (*ResetPersonalPINInput) SetUserId 

func (s *ResetPersonalPINInput) SetUserId(v string) *ResetPersonalPINInput

SetUserId sets the UserId field's value.

func (ResetPersonalPINInput) String 

func (s ResetPersonalPINInput) String() string

String returns the string representation

func (*ResetPersonalPINInput) Validate 

func (s *ResetPersonalPINInput) Validate() error

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

type ResetPersonalPINOutput 

type ResetPersonalPINOutput struct {

	// The user details and new personal meeting PIN.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (ResetPersonalPINOutput) GoString 

func (s ResetPersonalPINOutput) GoString() string

GoString returns the string representation

func (*ResetPersonalPINOutput) SetUser 

func (s *ResetPersonalPINOutput) SetUser(v *User) *ResetPersonalPINOutput

SetUser sets the User field's value.

func (ResetPersonalPINOutput) String 

func (s ResetPersonalPINOutput) String() string

String returns the string representation

type UpdateAccountInput 

type UpdateAccountInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The new name for the specified Amazon Chime account.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAccountInput) GoString 

func (s UpdateAccountInput) GoString() string

GoString returns the string representation

func (*UpdateAccountInput) SetAccountId 

func (s *UpdateAccountInput) SetAccountId(v string) *UpdateAccountInput

SetAccountId sets the AccountId field's value.

func (*UpdateAccountInput) SetName 

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

SetName sets the Name field's value.

func (UpdateAccountInput) String 

func (s UpdateAccountInput) String() string

String returns the string representation

func (*UpdateAccountInput) Validate 

func (s *UpdateAccountInput) Validate() error

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

type UpdateAccountOutput 

type UpdateAccountOutput struct {

	// The updated Amazon Chime account details.
	Account *Account `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAccountOutput) GoString 

func (s UpdateAccountOutput) GoString() string

GoString returns the string representation

func (*UpdateAccountOutput) SetAccount 

func (s *UpdateAccountOutput) SetAccount(v *Account) *UpdateAccountOutput

SetAccount sets the Account field's value.

func (UpdateAccountOutput) String 

func (s UpdateAccountOutput) String() string

String returns the string representation

type UpdateAccountSettingsInput 

type UpdateAccountSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The Amazon Chime account settings to update.
	//
	// AccountSettings is a required field
	AccountSettings *AccountSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAccountSettingsInput) GoString 

func (s UpdateAccountSettingsInput) GoString() string

GoString returns the string representation

func (*UpdateAccountSettingsInput) SetAccountId 

func (s *UpdateAccountSettingsInput) SetAccountId(v string) *UpdateAccountSettingsInput

SetAccountId sets the AccountId field's value.

func (*UpdateAccountSettingsInput) SetAccountSettings 

func (s *UpdateAccountSettingsInput) SetAccountSettings(v *AccountSettings) *UpdateAccountSettingsInput

SetAccountSettings sets the AccountSettings field's value.

func (UpdateAccountSettingsInput) String 

func (s UpdateAccountSettingsInput) String() string

String returns the string representation

func (*UpdateAccountSettingsInput) Validate 

func (s *UpdateAccountSettingsInput) Validate() error

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

type UpdateAccountSettingsOutput 

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

func (UpdateAccountSettingsOutput) GoString 

func (s UpdateAccountSettingsOutput) GoString() string

GoString returns the string representation

func (UpdateAccountSettingsOutput) String 

func (s UpdateAccountSettingsOutput) String() string

String returns the string representation

type UpdateUserInput 

type UpdateUserInput struct {

	// The Amazon Chime account ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The user license type to update. This must be a supported license type for
	// the Amazon Chime account that the user belongs to.
	LicenseType *string `type:"string" enum:"License"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserInput) GoString 

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (*UpdateUserInput) SetAccountId 

func (s *UpdateUserInput) SetAccountId(v string) *UpdateUserInput

SetAccountId sets the AccountId field's value.

func (*UpdateUserInput) SetLicenseType 

func (s *UpdateUserInput) SetLicenseType(v string) *UpdateUserInput

SetLicenseType sets the LicenseType field's value.

func (*UpdateUserInput) SetUserId 

func (s *UpdateUserInput) SetUserId(v string) *UpdateUserInput

SetUserId sets the UserId field's value.

func (UpdateUserInput) String 

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate 

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The updated user details.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

func (*UpdateUserOutput) SetUser 

func (s *UpdateUserOutput) SetUser(v *User) *UpdateUserOutput

SetUser sets the User field's value.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation

type UpdateUserRequestItem 

type UpdateUserRequestItem struct {

	// The user license type.
	LicenseType *string `type:"string" enum:"License"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The user ID and user fields to update, used with the BatchUpdateUser action.

func (UpdateUserRequestItem) GoString 

func (s UpdateUserRequestItem) GoString() string

GoString returns the string representation

func (*UpdateUserRequestItem) SetLicenseType 

func (s *UpdateUserRequestItem) SetLicenseType(v string) *UpdateUserRequestItem

SetLicenseType sets the LicenseType field's value.

func (*UpdateUserRequestItem) SetUserId 

func (s *UpdateUserRequestItem) SetUserId(v string) *UpdateUserRequestItem

SetUserId sets the UserId field's value.

func (UpdateUserRequestItem) String 

func (s UpdateUserRequestItem) String() string

String returns the string representation

func (*UpdateUserRequestItem) Validate 

func (s *UpdateUserRequestItem) Validate() error

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

type User 

type User struct {

	// The Amazon Chime account ID.
	AccountId *string `type:"string"`

	// The display name of the user.
	DisplayName *string `type:"string" sensitive:"true"`

	// Date and time when the user is invited to the Amazon Chime account, in ISO
	// 8601 format.
	InvitedOn *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The license type for the user.
	LicenseType *string `type:"string" enum:"License"`

	// The user's personal meeting PIN.
	PersonalPIN *string `type:"string"`

	// The primary email address of the user.
	PrimaryEmail *string `type:"string" sensitive:"true"`

	// Date and time when the user is registered, in ISO 8601 format.
	RegisteredOn *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The user ID.
	//
	// UserId is a required field
	UserId *string `type:"string" required:"true"`

	// The user invite status.
	UserInvitationStatus *string `type:"string" enum:"InviteStatus"`

	// The user registration status.
	UserRegistrationStatus *string `type:"string" enum:"RegistrationStatus"`
	// contains filtered or unexported fields
}

The user on the Amazon Chime account.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation

func (*User) SetAccountId 

func (s *User) SetAccountId(v string) *User

SetAccountId sets the AccountId field's value.

func (*User) SetDisplayName 

func (s *User) SetDisplayName(v string) *User

SetDisplayName sets the DisplayName field's value.

func (*User) SetInvitedOn 

func (s *User) SetInvitedOn(v time.Time) *User

SetInvitedOn sets the InvitedOn field's value.

func (*User) SetLicenseType 

func (s *User) SetLicenseType(v string) *User

SetLicenseType sets the LicenseType field's value.

func (*User) SetPersonalPIN 

func (s *User) SetPersonalPIN(v string) *User

SetPersonalPIN sets the PersonalPIN field's value.

func (*User) SetPrimaryEmail 

func (s *User) SetPrimaryEmail(v string) *User

SetPrimaryEmail sets the PrimaryEmail field's value.

func (*User) SetRegisteredOn 

func (s *User) SetRegisteredOn(v time.Time) *User

SetRegisteredOn sets the RegisteredOn field's value.

func (*User) SetUserId 

func (s *User) SetUserId(v string) *User

SetUserId sets the UserId field's value.

func (*User) SetUserInvitationStatus 

func (s *User) SetUserInvitationStatus(v string) *User

SetUserInvitationStatus sets the UserInvitationStatus field's value.

func (*User) SetUserRegistrationStatus 

func (s *User) SetUserRegistrationStatus(v string) *User

SetUserRegistrationStatus sets the UserRegistrationStatus field's value.

func (User) String 

func (s User) String() string

String returns the string representation

type UserError 

type UserError struct {

	// The error code.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// The error message.
	ErrorMessage *string `type:"string"`

	// The user ID for which the action failed.
	UserId *string `type:"string"`
	// contains filtered or unexported fields
}

The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

func (UserError) GoString 

func (s UserError) GoString() string

GoString returns the string representation

func (*UserError) SetErrorCode 

func (s *UserError) SetErrorCode(v string) *UserError

SetErrorCode sets the ErrorCode field's value.

func (*UserError) SetErrorMessage 

func (s *UserError) SetErrorMessage(v string) *UserError

SetErrorMessage sets the ErrorMessage field's value.

func (*UserError) SetUserId 

func (s *UserError) SetUserId(v string) *UserError

SetUserId sets the UserId field's value.

func (UserError) String 

func (s UserError) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package chimeiface provides an interface to enable mocking the Amazon Chime service client for testing your code.
 Package chimeiface provides an interface to enable mocking the Amazon Chime service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.