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 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
- type Account
- type AccountSettings
- type AccountType
- type BatchSuspendUserInput
- type BatchSuspendUserOutput
- type BatchSuspendUserRequest
- type BatchUnsuspendUserInput
- type BatchUnsuspendUserOutput
- type BatchUnsuspendUserRequest
- type BatchUpdateUserInput
- type BatchUpdateUserOutput
- type BatchUpdateUserRequest
- type Chime
- func (c *Chime) BatchSuspendUserRequest(input *BatchSuspendUserInput) BatchSuspendUserRequest
- func (c *Chime) BatchUnsuspendUserRequest(input *BatchUnsuspendUserInput) BatchUnsuspendUserRequest
- func (c *Chime) BatchUpdateUserRequest(input *BatchUpdateUserInput) BatchUpdateUserRequest
- func (c *Chime) CreateAccountRequest(input *CreateAccountInput) CreateAccountRequest
- func (c *Chime) DeleteAccountRequest(input *DeleteAccountInput) DeleteAccountRequest
- func (c *Chime) GetAccountRequest(input *GetAccountInput) GetAccountRequest
- func (c *Chime) GetAccountSettingsRequest(input *GetAccountSettingsInput) GetAccountSettingsRequest
- func (c *Chime) GetUserRequest(input *GetUserInput) GetUserRequest
- func (c *Chime) InviteUsersRequest(input *InviteUsersInput) InviteUsersRequest
- func (c *Chime) ListAccountsRequest(input *ListAccountsInput) ListAccountsRequest
- func (c *Chime) ListUsersRequest(input *ListUsersInput) ListUsersRequest
- func (c *Chime) LogoutUserRequest(input *LogoutUserInput) LogoutUserRequest
- func (c *Chime) ResetPersonalPINRequest(input *ResetPersonalPINInput) ResetPersonalPINRequest
- func (c *Chime) UpdateAccountRequest(input *UpdateAccountInput) UpdateAccountRequest
- func (c *Chime) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) UpdateAccountSettingsRequest
- func (c *Chime) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest
- type CreateAccountInput
- type CreateAccountOutput
- type CreateAccountRequest
- type DeleteAccountInput
- type DeleteAccountOutput
- type DeleteAccountRequest
- type EmailStatus
- type ErrorCode
- type GetAccountInput
- type GetAccountOutput
- type GetAccountRequest
- type GetAccountSettingsInput
- type GetAccountSettingsOutput
- type GetAccountSettingsRequest
- type GetUserInput
- type GetUserOutput
- type GetUserRequest
- type Invite
- type InviteStatus
- type InviteUsersInput
- type InviteUsersOutput
- type InviteUsersRequest
- type License
- type ListAccountsInput
- type ListAccountsOutput
- type ListAccountsPager
- type ListAccountsRequest
- type ListUsersInput
- type ListUsersOutput
- type ListUsersPager
- type ListUsersRequest
- type LogoutUserInput
- type LogoutUserOutput
- type LogoutUserRequest
- type RegistrationStatus
- type ResetPersonalPINInput
- type ResetPersonalPINOutput
- type ResetPersonalPINRequest
- type UpdateAccountInput
- type UpdateAccountOutput
- type UpdateAccountRequest
- type UpdateAccountSettingsInput
- type UpdateAccountSettingsOutput
- type UpdateAccountSettingsRequest
- type UpdateUserInput
- type UpdateUserOutput
- type UpdateUserRequest
- type UpdateUserRequestItem
- type User
- type UserError
Constants ¶
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" // "ServiceUnavailableException". // // The service is currently unavailable. ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeThrottledClientException for service response error code // "ThrottledClientException". // // The client exceeded its request rate limit. ErrCodeThrottledClientException = "ThrottledClientException" // "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" )
const ( ServiceName = "chime" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
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 AccountType `type:"string" enum:"true"` // 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:"unix"` // The default license for the Amazon Chime account. DefaultLicense License `type:"string" enum:"true"` // The Amazon Chime account name. // // Name is a required field Name *string `type:"string" required:"true"` // Supported licenses for the Amazon Chime account. SupportedLicenses []License `type:"list"` // contains filtered or unexported fields }
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts. Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Account
func (Account) MarshalFields ¶
func (s Account) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AccountSettings
func (AccountSettings) GoString ¶
func (s AccountSettings) GoString() string
GoString returns the string representation
func (AccountSettings) MarshalFields ¶
func (s AccountSettings) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AccountSettings) String ¶
func (s AccountSettings) String() string
String returns the string representation
type AccountType ¶
type AccountType string
const ( AccountTypeTeam AccountType = "Team" AccountTypeEnterpriseDirectory AccountType = "EnterpriseDirectory" AccountTypeEnterpriseLwa AccountType = "EnterpriseLWA" AccountTypeEnterpriseOidc AccountType = "EnterpriseOIDC" )
Enum values for AccountType
func (AccountType) MarshalValue ¶
func (enum AccountType) MarshalValue() (string, error)
func (AccountType) MarshalValueBuf ¶
func (enum AccountType) MarshalValueBuf(b []byte) ([]byte, error)
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUserRequest
func (BatchSuspendUserInput) GoString ¶
func (s BatchSuspendUserInput) GoString() string
GoString returns the string representation
func (BatchSuspendUserInput) MarshalFields ¶
func (s BatchSuspendUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUserResponse
func (BatchSuspendUserOutput) GoString ¶
func (s BatchSuspendUserOutput) GoString() string
GoString returns the string representation
func (BatchSuspendUserOutput) MarshalFields ¶
func (s BatchSuspendUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BatchSuspendUserOutput) SDKResponseMetadata ¶
func (s BatchSuspendUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (BatchSuspendUserOutput) String ¶
func (s BatchSuspendUserOutput) String() string
String returns the string representation
type BatchSuspendUserRequest ¶
type BatchSuspendUserRequest struct { *aws.Request Input *BatchSuspendUserInput Copy func(*BatchSuspendUserInput) BatchSuspendUserRequest }
BatchSuspendUserRequest is a API request type for the BatchSuspendUser API operation.
func (BatchSuspendUserRequest) Send ¶
func (r BatchSuspendUserRequest) Send() (*BatchSuspendUserOutput, error)
Send marshals and sends the BatchSuspendUser API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUserRequest
func (BatchUnsuspendUserInput) GoString ¶
func (s BatchUnsuspendUserInput) GoString() string
GoString returns the string representation
func (BatchUnsuspendUserInput) MarshalFields ¶
func (s BatchUnsuspendUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUserResponse
func (BatchUnsuspendUserOutput) GoString ¶
func (s BatchUnsuspendUserOutput) GoString() string
GoString returns the string representation
func (BatchUnsuspendUserOutput) MarshalFields ¶
func (s BatchUnsuspendUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BatchUnsuspendUserOutput) SDKResponseMetadata ¶
func (s BatchUnsuspendUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (BatchUnsuspendUserOutput) String ¶
func (s BatchUnsuspendUserOutput) String() string
String returns the string representation
type BatchUnsuspendUserRequest ¶
type BatchUnsuspendUserRequest struct { *aws.Request Input *BatchUnsuspendUserInput Copy func(*BatchUnsuspendUserInput) BatchUnsuspendUserRequest }
BatchUnsuspendUserRequest is a API request type for the BatchUnsuspendUser API operation.
func (BatchUnsuspendUserRequest) Send ¶
func (r BatchUnsuspendUserRequest) Send() (*BatchUnsuspendUserOutput, error)
Send marshals and sends the BatchUnsuspendUser API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUserRequest
func (BatchUpdateUserInput) GoString ¶
func (s BatchUpdateUserInput) GoString() string
GoString returns the string representation
func (BatchUpdateUserInput) MarshalFields ¶
func (s BatchUpdateUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUserResponse
func (BatchUpdateUserOutput) GoString ¶
func (s BatchUpdateUserOutput) GoString() string
GoString returns the string representation
func (BatchUpdateUserOutput) MarshalFields ¶
func (s BatchUpdateUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BatchUpdateUserOutput) SDKResponseMetadata ¶
func (s BatchUpdateUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (BatchUpdateUserOutput) String ¶
func (s BatchUpdateUserOutput) String() string
String returns the string representation
type BatchUpdateUserRequest ¶
type BatchUpdateUserRequest struct { *aws.Request Input *BatchUpdateUserInput Copy func(*BatchUpdateUserInput) BatchUpdateUserRequest }
BatchUpdateUserRequest is a API request type for the BatchUpdateUser API operation.
func (BatchUpdateUserRequest) Send ¶
func (r BatchUpdateUserRequest) Send() (*BatchUpdateUserOutput, error)
Send marshals and sends the BatchUpdateUser API request.
type Chime ¶
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 ¶
New creates a new instance of the Chime client with a config.
Example:
// Create a Chime client from just a config. svc := chime.New(myConfig)
func (*Chime) BatchSuspendUserRequest ¶
func (c *Chime) BatchSuspendUserRequest(input *BatchSuspendUserInput) BatchSuspendUserRequest
BatchSuspendUserRequest returns a request value for making 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.
// Example sending a request using the BatchSuspendUserRequest method. req := client.BatchSuspendUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchSuspendUser
func (*Chime) BatchUnsuspendUserRequest ¶
func (c *Chime) BatchUnsuspendUserRequest(input *BatchUnsuspendUserInput) BatchUnsuspendUserRequest
BatchUnsuspendUserRequest returns a request value for making 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.
// Example sending a request using the BatchUnsuspendUserRequest method. req := client.BatchUnsuspendUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUnsuspendUser
func (*Chime) BatchUpdateUserRequest ¶
func (c *Chime) BatchUpdateUserRequest(input *BatchUpdateUserInput) BatchUpdateUserRequest
BatchUpdateUserRequest returns a request value for making 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.
// Example sending a request using the BatchUpdateUserRequest method. req := client.BatchUpdateUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdateUser
func (*Chime) CreateAccountRequest ¶
func (c *Chime) CreateAccountRequest(input *CreateAccountInput) CreateAccountRequest
CreateAccountRequest returns a request value for making 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.
// Example sending a request using the CreateAccountRequest method. req := client.CreateAccountRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccount
func (*Chime) DeleteAccountRequest ¶
func (c *Chime) DeleteAccountRequest(input *DeleteAccountInput) DeleteAccountRequest
DeleteAccountRequest returns a request value for making 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.
// Example sending a request using the DeleteAccountRequest method. req := client.DeleteAccountRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccount
func (*Chime) GetAccountRequest ¶
func (c *Chime) GetAccountRequest(input *GetAccountInput) GetAccountRequest
GetAccountRequest returns a request value for making API operation for Amazon Chime.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
// Example sending a request using the GetAccountRequest method. req := client.GetAccountRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccount
func (*Chime) GetAccountSettingsRequest ¶
func (c *Chime) GetAccountSettingsRequest(input *GetAccountSettingsInput) GetAccountSettingsRequest
GetAccountSettingsRequest returns a request value for making 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.
// Example sending a request using the GetAccountSettingsRequest method. req := client.GetAccountSettingsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettings
func (*Chime) GetUserRequest ¶
func (c *Chime) GetUserRequest(input *GetUserInput) GetUserRequest
GetUserRequest returns a request value for making 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.
// Example sending a request using the GetUserRequest method. req := client.GetUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUser
func (*Chime) InviteUsersRequest ¶
func (c *Chime) InviteUsersRequest(input *InviteUsersInput) InviteUsersRequest
InviteUsersRequest returns a request value for making 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.
// Example sending a request using the InviteUsersRequest method. req := client.InviteUsersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsers
func (*Chime) ListAccountsRequest ¶
func (c *Chime) ListAccountsRequest(input *ListAccountsInput) ListAccountsRequest
ListAccountsRequest returns a request value for making 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.
// Example sending a request using the ListAccountsRequest method. req := client.ListAccountsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccounts
func (*Chime) ListUsersRequest ¶
func (c *Chime) ListUsersRequest(input *ListUsersInput) ListUsersRequest
ListUsersRequest returns a request value for making 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.
// Example sending a request using the ListUsersRequest method. req := client.ListUsersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsers
func (*Chime) LogoutUserRequest ¶
func (c *Chime) LogoutUserRequest(input *LogoutUserInput) LogoutUserRequest
LogoutUserRequest returns a request value for making API operation for Amazon Chime.
Logs out the specified user from all of the devices they are currently logged into.
// Example sending a request using the LogoutUserRequest method. req := client.LogoutUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUser
func (*Chime) ResetPersonalPINRequest ¶
func (c *Chime) ResetPersonalPINRequest(input *ResetPersonalPINInput) ResetPersonalPINRequest
ResetPersonalPINRequest returns a request value for making 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.
// Example sending a request using the ResetPersonalPINRequest method. req := client.ResetPersonalPINRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPIN
func (*Chime) UpdateAccountRequest ¶
func (c *Chime) UpdateAccountRequest(input *UpdateAccountInput) UpdateAccountRequest
UpdateAccountRequest returns a request value for making API operation for Amazon Chime.
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
// Example sending a request using the UpdateAccountRequest method. req := client.UpdateAccountRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccount
func (*Chime) UpdateAccountSettingsRequest ¶
func (c *Chime) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) UpdateAccountSettingsRequest
UpdateAccountSettingsRequest returns a request value for making 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.
// Example sending a request using the UpdateAccountSettingsRequest method. req := client.UpdateAccountSettingsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettings
func (*Chime) UpdateUserRequest ¶
func (c *Chime) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest
UpdateUserRequest returns a request value for making API operation for Amazon Chime.
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
// Example sending a request using the UpdateUserRequest method. req := client.UpdateUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUser
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccountRequest
func (CreateAccountInput) GoString ¶
func (s CreateAccountInput) GoString() string
GoString returns the string representation
func (CreateAccountInput) MarshalFields ¶
func (s CreateAccountInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAccountResponse
func (CreateAccountOutput) GoString ¶
func (s CreateAccountOutput) GoString() string
GoString returns the string representation
func (CreateAccountOutput) MarshalFields ¶
func (s CreateAccountOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateAccountOutput) SDKResponseMetadata ¶
func (s CreateAccountOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateAccountOutput) String ¶
func (s CreateAccountOutput) String() string
String returns the string representation
type CreateAccountRequest ¶
type CreateAccountRequest struct { *aws.Request Input *CreateAccountInput Copy func(*CreateAccountInput) CreateAccountRequest }
CreateAccountRequest is a API request type for the CreateAccount API operation.
func (CreateAccountRequest) Send ¶
func (r CreateAccountRequest) Send() (*CreateAccountOutput, error)
Send marshals and sends the CreateAccount API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccountRequest
func (DeleteAccountInput) GoString ¶
func (s DeleteAccountInput) GoString() string
GoString returns the string representation
func (DeleteAccountInput) MarshalFields ¶
func (s DeleteAccountInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAccountResponse
func (DeleteAccountOutput) GoString ¶
func (s DeleteAccountOutput) GoString() string
GoString returns the string representation
func (DeleteAccountOutput) MarshalFields ¶
func (s DeleteAccountOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteAccountOutput) SDKResponseMetadata ¶
func (s DeleteAccountOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteAccountOutput) String ¶
func (s DeleteAccountOutput) String() string
String returns the string representation
type DeleteAccountRequest ¶
type DeleteAccountRequest struct { *aws.Request Input *DeleteAccountInput Copy func(*DeleteAccountInput) DeleteAccountRequest }
DeleteAccountRequest is a API request type for the DeleteAccount API operation.
func (DeleteAccountRequest) Send ¶
func (r DeleteAccountRequest) Send() (*DeleteAccountOutput, error)
Send marshals and sends the DeleteAccount API request.
type EmailStatus ¶
type EmailStatus string
const ( EmailStatusNotSent EmailStatus = "NotSent" EmailStatusSent EmailStatus = "Sent" EmailStatusFailed EmailStatus = "Failed" )
Enum values for EmailStatus
func (EmailStatus) MarshalValue ¶
func (enum EmailStatus) MarshalValue() (string, error)
func (EmailStatus) MarshalValueBuf ¶
func (enum EmailStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ErrorCode ¶
type ErrorCode string
const ( ErrorCodeForbidden ErrorCode = "Forbidden" ErrorCodeNotFound ErrorCode = "NotFound" ErrorCodeBadRequest ErrorCode = "BadRequest" ErrorCodeConflict ErrorCode = "Conflict" ErrorCodeServiceFailure ErrorCode = "ServiceFailure" ErrorCodeUnprocessable ErrorCode = "Unprocessable" ErrorCodeThrottled ErrorCode = "Throttled" ErrorCodePreconditionFailed ErrorCode = "PreconditionFailed" )
Enum values for ErrorCode
func (ErrorCode) MarshalValue ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountRequest
func (GetAccountInput) GoString ¶
func (s GetAccountInput) GoString() string
GoString returns the string representation
func (GetAccountInput) MarshalFields ¶
func (s GetAccountInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountResponse
func (GetAccountOutput) GoString ¶
func (s GetAccountOutput) GoString() string
GoString returns the string representation
func (GetAccountOutput) MarshalFields ¶
func (s GetAccountOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAccountOutput) SDKResponseMetadata ¶
func (s GetAccountOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetAccountOutput) String ¶
func (s GetAccountOutput) String() string
String returns the string representation
type GetAccountRequest ¶
type GetAccountRequest struct { *aws.Request Input *GetAccountInput Copy func(*GetAccountInput) GetAccountRequest }
GetAccountRequest is a API request type for the GetAccount API operation.
func (GetAccountRequest) Send ¶
func (r GetAccountRequest) Send() (*GetAccountOutput, error)
Send marshals and sends the GetAccount API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettingsRequest
func (GetAccountSettingsInput) GoString ¶
func (s GetAccountSettingsInput) GoString() string
GoString returns the string representation
func (GetAccountSettingsInput) MarshalFields ¶
func (s GetAccountSettingsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettingsResponse
func (GetAccountSettingsOutput) GoString ¶
func (s GetAccountSettingsOutput) GoString() string
GoString returns the string representation
func (GetAccountSettingsOutput) MarshalFields ¶
func (s GetAccountSettingsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAccountSettingsOutput) SDKResponseMetadata ¶
func (s GetAccountSettingsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetAccountSettingsOutput) String ¶
func (s GetAccountSettingsOutput) String() string
String returns the string representation
type GetAccountSettingsRequest ¶
type GetAccountSettingsRequest struct { *aws.Request Input *GetAccountSettingsInput Copy func(*GetAccountSettingsInput) GetAccountSettingsRequest }
GetAccountSettingsRequest is a API request type for the GetAccountSettings API operation.
func (GetAccountSettingsRequest) Send ¶
func (r GetAccountSettingsRequest) Send() (*GetAccountSettingsOutput, error)
Send marshals and sends the GetAccountSettings API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserRequest
func (GetUserInput) GoString ¶
func (s GetUserInput) GoString() string
GoString returns the string representation
func (GetUserInput) MarshalFields ¶
func (s GetUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserResponse
func (GetUserOutput) GoString ¶
func (s GetUserOutput) GoString() string
GoString returns the string representation
func (GetUserOutput) MarshalFields ¶
func (s GetUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUserOutput) SDKResponseMetadata ¶
func (s GetUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetUserOutput) String ¶
func (s GetUserOutput) String() string
String returns the string representation
type GetUserRequest ¶
type GetUserRequest struct { *aws.Request Input *GetUserInput Copy func(*GetUserInput) GetUserRequest }
GetUserRequest is a API request type for the GetUser API operation.
func (GetUserRequest) Send ¶
func (r GetUserRequest) Send() (*GetUserOutput, error)
Send marshals and sends the GetUser API request.
type Invite ¶
type Invite struct { // The email address to which the invite is sent. EmailAddress *string `type:"string"` // The status of the invite email. EmailStatus EmailStatus `type:"string" enum:"true"` // The invite ID. InviteId *string `type:"string"` // The status of the invite. Status InviteStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
Invitation object returned after emailing users to invite them to join the Amazon Chime Team account. Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Invite
func (Invite) MarshalFields ¶
func (s Invite) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type InviteStatus ¶
type InviteStatus string
const ( InviteStatusPending InviteStatus = "Pending" InviteStatusAccepted InviteStatus = "Accepted" InviteStatusFailed InviteStatus = "Failed" )
Enum values for InviteStatus
func (InviteStatus) MarshalValue ¶
func (enum InviteStatus) MarshalValue() (string, error)
func (InviteStatus) MarshalValueBuf ¶
func (enum InviteStatus) MarshalValueBuf(b []byte) ([]byte, error)
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersRequest
func (InviteUsersInput) GoString ¶
func (s InviteUsersInput) GoString() string
GoString returns the string representation
func (InviteUsersInput) MarshalFields ¶
func (s InviteUsersInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersResponse
func (InviteUsersOutput) GoString ¶
func (s InviteUsersOutput) GoString() string
GoString returns the string representation
func (InviteUsersOutput) MarshalFields ¶
func (s InviteUsersOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InviteUsersOutput) SDKResponseMetadata ¶
func (s InviteUsersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (InviteUsersOutput) String ¶
func (s InviteUsersOutput) String() string
String returns the string representation
type InviteUsersRequest ¶
type InviteUsersRequest struct { *aws.Request Input *InviteUsersInput Copy func(*InviteUsersInput) InviteUsersRequest }
InviteUsersRequest is a API request type for the InviteUsers API operation.
func (InviteUsersRequest) Send ¶
func (r InviteUsersRequest) Send() (*InviteUsersOutput, error)
Send marshals and sends the InviteUsers API request.
type License ¶
type License string
const ( LicenseBasic License = "Basic" LicensePlus License = "Plus" LicensePro License = "Pro" LicenseProTrial License = "ProTrial" )
Enum values for License
func (License) MarshalValue ¶
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"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsRequest
func (ListAccountsInput) GoString ¶
func (s ListAccountsInput) GoString() string
GoString returns the string representation
func (ListAccountsInput) MarshalFields ¶
func (s ListAccountsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsResponse
func (ListAccountsOutput) GoString ¶
func (s ListAccountsOutput) GoString() string
GoString returns the string representation
func (ListAccountsOutput) MarshalFields ¶
func (s ListAccountsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListAccountsOutput) SDKResponseMetadata ¶
func (s ListAccountsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListAccountsOutput) String ¶
func (s ListAccountsOutput) String() string
String returns the string representation
type ListAccountsPager ¶
ListAccountsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListAccountsPager) CurrentPage ¶
func (p *ListAccountsPager) CurrentPage() *ListAccountsOutput
type ListAccountsRequest ¶
type ListAccountsRequest struct { *aws.Request Input *ListAccountsInput Copy func(*ListAccountsInput) ListAccountsRequest }
ListAccountsRequest is a API request type for the ListAccounts API operation.
func (*ListAccountsRequest) Paginate ¶
func (p *ListAccountsRequest) Paginate(opts ...aws.Option) ListAccountsPager
Paginate pages iterates over the pages of a ListAccountsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListAccounts operation. req := client.ListAccountsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListAccountsRequest) Send ¶
func (r ListAccountsRequest) Send() (*ListAccountsOutput, error)
Send marshals and sends the ListAccounts API request.
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"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsersRequest
func (ListUsersInput) GoString ¶
func (s ListUsersInput) GoString() string
GoString returns the string representation
func (ListUsersInput) MarshalFields ¶
func (s ListUsersInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsersResponse
func (ListUsersOutput) GoString ¶
func (s ListUsersOutput) GoString() string
GoString returns the string representation
func (ListUsersOutput) MarshalFields ¶
func (s ListUsersOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListUsersOutput) SDKResponseMetadata ¶
func (s ListUsersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUsersOutput) String ¶
func (s ListUsersOutput) String() string
String returns the string representation
type ListUsersPager ¶
ListUsersPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListUsersPager) CurrentPage ¶
func (p *ListUsersPager) CurrentPage() *ListUsersOutput
type ListUsersRequest ¶
type ListUsersRequest struct { *aws.Request Input *ListUsersInput Copy func(*ListUsersInput) ListUsersRequest }
ListUsersRequest is a API request type for the ListUsers API operation.
func (*ListUsersRequest) Paginate ¶
func (p *ListUsersRequest) Paginate(opts ...aws.Option) ListUsersPager
Paginate pages iterates over the pages of a ListUsersRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListUsers operation. req := client.ListUsersRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListUsersRequest) Send ¶
func (r ListUsersRequest) Send() (*ListUsersOutput, error)
Send marshals and sends the ListUsers API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUserRequest
func (LogoutUserInput) GoString ¶
func (s LogoutUserInput) GoString() string
GoString returns the string representation
func (LogoutUserInput) MarshalFields ¶
func (s LogoutUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUserResponse
func (LogoutUserOutput) GoString ¶
func (s LogoutUserOutput) GoString() string
GoString returns the string representation
func (LogoutUserOutput) MarshalFields ¶
func (s LogoutUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (LogoutUserOutput) SDKResponseMetadata ¶
func (s LogoutUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (LogoutUserOutput) String ¶
func (s LogoutUserOutput) String() string
String returns the string representation
type LogoutUserRequest ¶
type LogoutUserRequest struct { *aws.Request Input *LogoutUserInput Copy func(*LogoutUserInput) LogoutUserRequest }
LogoutUserRequest is a API request type for the LogoutUser API operation.
func (LogoutUserRequest) Send ¶
func (r LogoutUserRequest) Send() (*LogoutUserOutput, error)
Send marshals and sends the LogoutUser API request.
type RegistrationStatus ¶
type RegistrationStatus string
const ( RegistrationStatusUnregistered RegistrationStatus = "Unregistered" RegistrationStatusRegistered RegistrationStatus = "Registered" RegistrationStatusSuspended RegistrationStatus = "Suspended" )
Enum values for RegistrationStatus
func (RegistrationStatus) MarshalValue ¶
func (enum RegistrationStatus) MarshalValue() (string, error)
func (RegistrationStatus) MarshalValueBuf ¶
func (enum RegistrationStatus) MarshalValueBuf(b []byte) ([]byte, error)
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPINRequest
func (ResetPersonalPINInput) GoString ¶
func (s ResetPersonalPINInput) GoString() string
GoString returns the string representation
func (ResetPersonalPINInput) MarshalFields ¶
func (s ResetPersonalPINInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPINResponse
func (ResetPersonalPINOutput) GoString ¶
func (s ResetPersonalPINOutput) GoString() string
GoString returns the string representation
func (ResetPersonalPINOutput) MarshalFields ¶
func (s ResetPersonalPINOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ResetPersonalPINOutput) SDKResponseMetadata ¶
func (s ResetPersonalPINOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ResetPersonalPINOutput) String ¶
func (s ResetPersonalPINOutput) String() string
String returns the string representation
type ResetPersonalPINRequest ¶
type ResetPersonalPINRequest struct { *aws.Request Input *ResetPersonalPINInput Copy func(*ResetPersonalPINInput) ResetPersonalPINRequest }
ResetPersonalPINRequest is a API request type for the ResetPersonalPIN API operation.
func (ResetPersonalPINRequest) Send ¶
func (r ResetPersonalPINRequest) Send() (*ResetPersonalPINOutput, error)
Send marshals and sends the ResetPersonalPIN API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountRequest
func (UpdateAccountInput) GoString ¶
func (s UpdateAccountInput) GoString() string
GoString returns the string representation
func (UpdateAccountInput) MarshalFields ¶
func (s UpdateAccountInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountResponse
func (UpdateAccountOutput) GoString ¶
func (s UpdateAccountOutput) GoString() string
GoString returns the string representation
func (UpdateAccountOutput) MarshalFields ¶
func (s UpdateAccountOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAccountOutput) SDKResponseMetadata ¶
func (s UpdateAccountOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateAccountOutput) String ¶
func (s UpdateAccountOutput) String() string
String returns the string representation
type UpdateAccountRequest ¶
type UpdateAccountRequest struct { *aws.Request Input *UpdateAccountInput Copy func(*UpdateAccountInput) UpdateAccountRequest }
UpdateAccountRequest is a API request type for the UpdateAccount API operation.
func (UpdateAccountRequest) Send ¶
func (r UpdateAccountRequest) Send() (*UpdateAccountOutput, error)
Send marshals and sends the UpdateAccount API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettingsRequest
func (UpdateAccountSettingsInput) GoString ¶
func (s UpdateAccountSettingsInput) GoString() string
GoString returns the string representation
func (UpdateAccountSettingsInput) MarshalFields ¶
func (s UpdateAccountSettingsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAccountSettingsResponse
func (UpdateAccountSettingsOutput) GoString ¶
func (s UpdateAccountSettingsOutput) GoString() string
GoString returns the string representation
func (UpdateAccountSettingsOutput) MarshalFields ¶
func (s UpdateAccountSettingsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAccountSettingsOutput) SDKResponseMetadata ¶
func (s UpdateAccountSettingsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateAccountSettingsOutput) String ¶
func (s UpdateAccountSettingsOutput) String() string
String returns the string representation
type UpdateAccountSettingsRequest ¶
type UpdateAccountSettingsRequest struct { *aws.Request Input *UpdateAccountSettingsInput Copy func(*UpdateAccountSettingsInput) UpdateAccountSettingsRequest }
UpdateAccountSettingsRequest is a API request type for the UpdateAccountSettings API operation.
func (UpdateAccountSettingsRequest) Send ¶
func (r UpdateAccountSettingsRequest) Send() (*UpdateAccountSettingsOutput, error)
Send marshals and sends the UpdateAccountSettings API request.
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 License `type:"string" enum:"true"` // The user ID. // // UserId is a required field UserId *string `location:"uri" locationName:"userId" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserRequest
func (UpdateUserInput) GoString ¶
func (s UpdateUserInput) GoString() string
GoString returns the string representation
func (UpdateUserInput) MarshalFields ¶
func (s UpdateUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserResponse
func (UpdateUserOutput) GoString ¶
func (s UpdateUserOutput) GoString() string
GoString returns the string representation
func (UpdateUserOutput) MarshalFields ¶
func (s UpdateUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateUserOutput) SDKResponseMetadata ¶
func (s UpdateUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateUserOutput) String ¶
func (s UpdateUserOutput) String() string
String returns the string representation
type UpdateUserRequest ¶
type UpdateUserRequest struct { *aws.Request Input *UpdateUserInput Copy func(*UpdateUserInput) UpdateUserRequest }
UpdateUserRequest is a API request type for the UpdateUser API operation.
func (UpdateUserRequest) Send ¶
func (r UpdateUserRequest) Send() (*UpdateUserOutput, error)
Send marshals and sends the UpdateUser API request.
type UpdateUserRequestItem ¶
type UpdateUserRequestItem struct { // The user license type. LicenseType License `type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserRequestItem
func (UpdateUserRequestItem) GoString ¶
func (s UpdateUserRequestItem) GoString() string
GoString returns the string representation
func (UpdateUserRequestItem) MarshalFields ¶
func (s UpdateUserRequestItem) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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"` // Date and time when the user is invited to the Amazon Chime account, in ISO // 8601 format. InvitedOn *time.Time `type:"timestamp" timestampFormat:"unix"` // The license type for the user. LicenseType License `type:"string" enum:"true"` // The user's personal meeting PIN. PersonalPIN *string `type:"string"` // The primary email address of the user. PrimaryEmail *string `type:"string"` // Date and time when the user is registered, in ISO 8601 format. RegisteredOn *time.Time `type:"timestamp" timestampFormat:"unix"` // The user ID. // // UserId is a required field UserId *string `type:"string" required:"true"` // The user invite status. UserInvitationStatus InviteStatus `type:"string" enum:"true"` // The user registration status. UserRegistrationStatus RegistrationStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
The user on the Amazon Chime account. Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/User
func (User) MarshalFields ¶
func (s User) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type UserError ¶
type UserError struct { // The error code. ErrorCode ErrorCode `type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UserError
func (UserError) MarshalFields ¶
func (s UserError) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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. |