AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Connect

import "github.com/aws/aws-sdk-go/service/connect"

type Connect struct { *client.Client }

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

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

Client

Type: *client.Client

Method

CreateUser

func (c *Connect) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for Amazon Connect Service.

Creates a new user account in your Amazon Connect instance.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeLimitExceededException "LimitExceededException" The allowed limit for the resource has been reached.

  • ErrCodeDuplicateResourceException "DuplicateResourceException" A resource with that name already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser

CreateUserRequest

func (c *Connect) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser 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 CreateUser for more information on using the CreateUser 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 CreateUserRequest method. req, resp := client.CreateUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser

CreateUserWithContext

func (c *Connect) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

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

See CreateUser 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteUser

func (c *Connect) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for Amazon Connect Service.

Deletes a user account from Amazon Connect.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser

DeleteUserRequest

func (c *Connect) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser 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 DeleteUser for more information on using the DeleteUser 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 DeleteUserRequest method. req, resp := client.DeleteUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser

DeleteUserWithContext

func (c *Connect) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

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

See DeleteUser 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeUser

func (c *Connect) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for Amazon Connect Service.

Returns a User object that contains information about the user account specified by the UserId.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser

DescribeUserHierarchyGroup

func (c *Connect) DescribeUserHierarchyGroup(input *DescribeUserHierarchyGroupInput) (*DescribeUserHierarchyGroupOutput, error)

DescribeUserHierarchyGroup API operation for Amazon Connect Service.

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup

DescribeUserHierarchyGroupRequest

func (c *Connect) DescribeUserHierarchyGroupRequest(input *DescribeUserHierarchyGroupInput) (req *request.Request, output *DescribeUserHierarchyGroupOutput)

DescribeUserHierarchyGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeUserHierarchyGroup 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 DescribeUserHierarchyGroup for more information on using the DescribeUserHierarchyGroup 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 DescribeUserHierarchyGroupRequest method. req, resp := client.DescribeUserHierarchyGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup

DescribeUserHierarchyGroupWithContext

func (c *Connect) DescribeUserHierarchyGroupWithContext(ctx aws.Context, input *DescribeUserHierarchyGroupInput, opts ...request.Option) (*DescribeUserHierarchyGroupOutput, error)

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

See DescribeUserHierarchyGroup 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeUserHierarchyStructure

func (c *Connect) DescribeUserHierarchyStructure(input *DescribeUserHierarchyStructureInput) (*DescribeUserHierarchyStructureOutput, error)

DescribeUserHierarchyStructure API operation for Amazon Connect Service.

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure

DescribeUserHierarchyStructureRequest

func (c *Connect) DescribeUserHierarchyStructureRequest(input *DescribeUserHierarchyStructureInput) (req *request.Request, output *DescribeUserHierarchyStructureOutput)

DescribeUserHierarchyStructureRequest generates a "aws/request.Request" representing the client's request for the DescribeUserHierarchyStructure 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 DescribeUserHierarchyStructure for more information on using the DescribeUserHierarchyStructure 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 DescribeUserHierarchyStructureRequest method. req, resp := client.DescribeUserHierarchyStructureRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure

DescribeUserHierarchyStructureWithContext

func (c *Connect) DescribeUserHierarchyStructureWithContext(ctx aws.Context, input *DescribeUserHierarchyStructureInput, opts ...request.Option) (*DescribeUserHierarchyStructureOutput, error)

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

See DescribeUserHierarchyStructure 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeUserRequest

func (c *Connect) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)

DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser 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 DescribeUser for more information on using the DescribeUser 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 DescribeUserRequest method. req, resp := client.DescribeUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser

DescribeUserWithContext

func (c *Connect) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)

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

See DescribeUser 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.

See Also

For more information about using this API, see AWS API Documentation.

GetContactAttributes

func (c *Connect) GetContactAttributes(input *GetContactAttributesInput) (*GetContactAttributesOutput, error)

GetContactAttributes API operation for Amazon Connect Service.

Retrieves the contact attributes associated with a contact.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes

GetContactAttributesRequest

func (c *Connect) GetContactAttributesRequest(input *GetContactAttributesInput) (req *request.Request, output *GetContactAttributesOutput)

GetContactAttributesRequest generates a "aws/request.Request" representing the client's request for the GetContactAttributes 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 GetContactAttributes for more information on using the GetContactAttributes 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 GetContactAttributesRequest method. req, resp := client.GetContactAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes

GetContactAttributesWithContext

func (c *Connect) GetContactAttributesWithContext(ctx aws.Context, input *GetContactAttributesInput, opts ...request.Option) (*GetContactAttributesOutput, error)

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

See GetContactAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

GetCurrentMetricData

func (c *Connect) GetCurrentMetricData(input *GetCurrentMetricDataInput) (*GetCurrentMetricDataOutput, error)

GetCurrentMetricData API operation for Amazon Connect Service.

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData 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 Connect Service's API operation GetCurrentMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData

GetCurrentMetricDataPages

func (c *Connect) GetCurrentMetricDataPages(input *GetCurrentMetricDataInput, fn func(*GetCurrentMetricDataOutput, bool) bool) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetCurrentMetricDataPagesWithContext

func (c *Connect) GetCurrentMetricDataPagesWithContext(ctx aws.Context, input *GetCurrentMetricDataInput, fn func(*GetCurrentMetricDataOutput, bool) bool, opts ...request.Option) error

GetCurrentMetricDataPagesWithContext same as GetCurrentMetricDataPages 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.

See Also

For more information about using this API, see AWS API Documentation.

GetCurrentMetricDataRequest

func (c *Connect) GetCurrentMetricDataRequest(input *GetCurrentMetricDataInput) (req *request.Request, output *GetCurrentMetricDataOutput)

GetCurrentMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetCurrentMetricData 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 GetCurrentMetricData for more information on using the GetCurrentMetricData 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 GetCurrentMetricDataRequest method. req, resp := client.GetCurrentMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData

GetCurrentMetricDataWithContext

func (c *Connect) GetCurrentMetricDataWithContext(ctx aws.Context, input *GetCurrentMetricDataInput, opts ...request.Option) (*GetCurrentMetricDataOutput, error)

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

See GetCurrentMetricData 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.

See Also

For more information about using this API, see AWS API Documentation.

GetFederationToken

func (c *Connect) GetFederationToken(input *GetFederationTokenInput) (*GetFederationTokenOutput, error)

GetFederationToken API operation for Amazon Connect Service.

Retrieves a token for federation.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeUserNotFoundException "UserNotFoundException" No user with the specified credentials was found in the Amazon Connect instance.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeDuplicateResourceException "DuplicateResourceException" A resource with that name already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken

GetFederationTokenRequest

func (c *Connect) GetFederationTokenRequest(input *GetFederationTokenInput) (req *request.Request, output *GetFederationTokenOutput)

GetFederationTokenRequest generates a "aws/request.Request" representing the client's request for the GetFederationToken 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 GetFederationToken for more information on using the GetFederationToken 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 GetFederationTokenRequest method. req, resp := client.GetFederationTokenRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken

GetFederationTokenWithContext

func (c *Connect) GetFederationTokenWithContext(ctx aws.Context, input *GetFederationTokenInput, opts ...request.Option) (*GetFederationTokenOutput, error)

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

See GetFederationToken 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.

See Also

For more information about using this API, see AWS API Documentation.

GetMetricData

func (c *Connect) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error)

GetMetricData API operation for Amazon Connect Service.

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData 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 Connect Service's API operation GetMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData

GetMetricDataPages

func (c *Connect) GetMetricDataPages(input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetMetricDataPagesWithContext

func (c *Connect) GetMetricDataPagesWithContext(ctx aws.Context, input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool, opts ...request.Option) error

GetMetricDataPagesWithContext same as GetMetricDataPages 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.

See Also

For more information about using this API, see AWS API Documentation.

GetMetricDataRequest

func (c *Connect) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput)

GetMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetMetricData 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 GetMetricData for more information on using the GetMetricData 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 GetMetricDataRequest method. req, resp := client.GetMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData

GetMetricDataWithContext

func (c *Connect) GetMetricDataWithContext(ctx aws.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error)

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

See GetMetricData 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.

See Also

For more information about using this API, see AWS API Documentation.

ListRoutingProfiles

func (c *Connect) ListRoutingProfiles(input *ListRoutingProfilesInput) (*ListRoutingProfilesOutput, error)

ListRoutingProfiles API operation for Amazon Connect Service.

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles

ListRoutingProfilesRequest

func (c *Connect) ListRoutingProfilesRequest(input *ListRoutingProfilesInput) (req *request.Request, output *ListRoutingProfilesOutput)

ListRoutingProfilesRequest generates a "aws/request.Request" representing the client's request for the ListRoutingProfiles 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 ListRoutingProfiles for more information on using the ListRoutingProfiles 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 ListRoutingProfilesRequest method. req, resp := client.ListRoutingProfilesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles

ListRoutingProfilesWithContext

func (c *Connect) ListRoutingProfilesWithContext(ctx aws.Context, input *ListRoutingProfilesInput, opts ...request.Option) (*ListRoutingProfilesOutput, error)

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

See ListRoutingProfiles 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.

See Also

For more information about using this API, see AWS API Documentation.

ListSecurityProfiles

func (c *Connect) ListSecurityProfiles(input *ListSecurityProfilesInput) (*ListSecurityProfilesOutput, error)

ListSecurityProfiles API operation for Amazon Connect Service.

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles

ListSecurityProfilesRequest

func (c *Connect) ListSecurityProfilesRequest(input *ListSecurityProfilesInput) (req *request.Request, output *ListSecurityProfilesOutput)

ListSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the ListSecurityProfiles 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 ListSecurityProfiles for more information on using the ListSecurityProfiles 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 ListSecurityProfilesRequest method. req, resp := client.ListSecurityProfilesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles

ListSecurityProfilesWithContext

func (c *Connect) ListSecurityProfilesWithContext(ctx aws.Context, input *ListSecurityProfilesInput, opts ...request.Option) (*ListSecurityProfilesOutput, error)

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

See ListSecurityProfiles 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.

See Also

For more information about using this API, see AWS API Documentation.

ListUserHierarchyGroups

func (c *Connect) ListUserHierarchyGroups(input *ListUserHierarchyGroupsInput) (*ListUserHierarchyGroupsOutput, error)

ListUserHierarchyGroups API operation for Amazon Connect Service.

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups

ListUserHierarchyGroupsRequest

func (c *Connect) ListUserHierarchyGroupsRequest(input *ListUserHierarchyGroupsInput) (req *request.Request, output *ListUserHierarchyGroupsOutput)

ListUserHierarchyGroupsRequest generates a "aws/request.Request" representing the client's request for the ListUserHierarchyGroups 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 ListUserHierarchyGroups for more information on using the ListUserHierarchyGroups 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 ListUserHierarchyGroupsRequest method. req, resp := client.ListUserHierarchyGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups

ListUserHierarchyGroupsWithContext

func (c *Connect) ListUserHierarchyGroupsWithContext(ctx aws.Context, input *ListUserHierarchyGroupsInput, opts ...request.Option) (*ListUserHierarchyGroupsOutput, error)

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

See ListUserHierarchyGroups 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.

See Also

For more information about using this API, see AWS API Documentation.

ListUsers

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

ListUsers API operation for Amazon Connect Service.

Returns a UserSummaryList, which is an array of UserSummary objects.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers

ListUsersRequest

func (c *Connect) 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/connect-2017-08-08/ListUsers

ListUsersWithContext

func (c *Connect) 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.

See Also

For more information about using this API, see AWS API Documentation.

StartOutboundVoiceContact

func (c *Connect) StartOutboundVoiceContact(input *StartOutboundVoiceContactInput) (*StartOutboundVoiceContactOutput, error)

StartOutboundVoiceContact API operation for Amazon Connect Service.

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

  • ErrCodeLimitExceededException "LimitExceededException" The allowed limit for the resource has been reached.

  • ErrCodeDestinationNotAllowedException "DestinationNotAllowedException" Outbound calls to the destination number are not allowed.

  • ErrCodeOutboundContactNotPermittedException "OutboundContactNotPermittedException" The contact is not permitted.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact

StartOutboundVoiceContactRequest

func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) (req *request.Request, output *StartOutboundVoiceContactOutput)

StartOutboundVoiceContactRequest generates a "aws/request.Request" representing the client's request for the StartOutboundVoiceContact 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 StartOutboundVoiceContact for more information on using the StartOutboundVoiceContact 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 StartOutboundVoiceContactRequest method. req, resp := client.StartOutboundVoiceContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact

StartOutboundVoiceContactWithContext

func (c *Connect) StartOutboundVoiceContactWithContext(ctx aws.Context, input *StartOutboundVoiceContactInput, opts ...request.Option) (*StartOutboundVoiceContactOutput, error)

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

See StartOutboundVoiceContact 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.

See Also

For more information about using this API, see AWS API Documentation.

StopContact

func (c *Connect) StopContact(input *StopContactInput) (*StopContactOutput, error)

StopContact API operation for Amazon Connect Service.

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact 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 Connect Service's API operation StopContact for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeContactNotFoundException "ContactNotFoundException" The contact with the specified ID is not active or does not exist.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact

StopContactRequest

func (c *Connect) StopContactRequest(input *StopContactInput) (req *request.Request, output *StopContactOutput)

StopContactRequest generates a "aws/request.Request" representing the client's request for the StopContact 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 StopContact for more information on using the StopContact 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 StopContactRequest method. req, resp := client.StopContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact

StopContactWithContext

func (c *Connect) StopContactWithContext(ctx aws.Context, input *StopContactInput, opts ...request.Option) (*StopContactOutput, error)

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

See StopContact 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateContactAttributes

func (c *Connect) UpdateContactAttributes(input *UpdateContactAttributesInput) (*UpdateContactAttributesOutput, error)

UpdateContactAttributes API operation for Amazon Connect Service.

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important:

You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes

UpdateContactAttributesRequest

func (c *Connect) UpdateContactAttributesRequest(input *UpdateContactAttributesInput) (req *request.Request, output *UpdateContactAttributesOutput)

UpdateContactAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateContactAttributes 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 UpdateContactAttributes for more information on using the UpdateContactAttributes 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 UpdateContactAttributesRequest method. req, resp := client.UpdateContactAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes

UpdateContactAttributesWithContext

func (c *Connect) UpdateContactAttributesWithContext(ctx aws.Context, input *UpdateContactAttributesInput, opts ...request.Option) (*UpdateContactAttributesOutput, error)

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

See UpdateContactAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateUserHierarchy

func (c *Connect) UpdateUserHierarchy(input *UpdateUserHierarchyInput) (*UpdateUserHierarchyOutput, error)

UpdateUserHierarchy API operation for Amazon Connect Service.

Assigns the specified hierarchy group to the user.

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

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserHierarchy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy

UpdateUserHierarchyRequest

func (c *Connect) UpdateUserHierarchyRequest(input *UpdateUserHierarchyInput) (req *request.Request, output *UpdateUserHierarchyOutput)

UpdateUserHierarchyRequest generates a "aws/request.Request" representing the client's request for the UpdateUserHierarchy 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 UpdateUserHierarchy for more information on using the UpdateUserHierarchy 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 UpdateUserHierarchyRequest method. req, resp := client.UpdateUserHierarchyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy

UpdateUserHierarchyWithContext

func (c *Connect) UpdateUserHierarchyWithContext(ctx aws.Context, input *UpdateUserHierarchyInput, opts ...request.Option) (*UpdateUserHierarchyOutput, error)

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

See UpdateUserHierarchy 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateUserIdentityInfo

func (c *Connect) UpdateUserIdentityInfo(input *UpdateUserIdentityInfoInput) (*UpdateUserIdentityInfoOutput, error)

UpdateUserIdentityInfo API operation for Amazon Connect Service.

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo

UpdateUserIdentityInfoRequest

func (c *Connect) UpdateUserIdentityInfoRequest(input *UpdateUserIdentityInfoInput) (req *request.Request, output *UpdateUserIdentityInfoOutput)

UpdateUserIdentityInfoRequest generates a "aws/request.Request" representing the client's request for the UpdateUserIdentityInfo 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 UpdateUserIdentityInfo for more information on using the UpdateUserIdentityInfo 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 UpdateUserIdentityInfoRequest method. req, resp := client.UpdateUserIdentityInfoRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo

UpdateUserIdentityInfoWithContext

func (c *Connect) UpdateUserIdentityInfoWithContext(ctx aws.Context, input *UpdateUserIdentityInfoInput, opts ...request.Option) (*UpdateUserIdentityInfoOutput, error)

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

See UpdateUserIdentityInfo 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateUserPhoneConfig

func (c *Connect) UpdateUserPhoneConfig(input *UpdateUserPhoneConfigInput) (*UpdateUserPhoneConfigOutput, error)

UpdateUserPhoneConfig API operation for Amazon Connect Service.

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

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

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserPhoneConfig for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig

UpdateUserPhoneConfigRequest

func (c *Connect) UpdateUserPhoneConfigRequest(input *UpdateUserPhoneConfigInput) (req *request.Request, output *UpdateUserPhoneConfigOutput)

UpdateUserPhoneConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateUserPhoneConfig 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 UpdateUserPhoneConfig for more information on using the UpdateUserPhoneConfig 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 UpdateUserPhoneConfigRequest method. req, resp := client.UpdateUserPhoneConfigRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig

UpdateUserPhoneConfigWithContext

func (c *Connect) UpdateUserPhoneConfigWithContext(ctx aws.Context, input *UpdateUserPhoneConfigInput, opts ...request.Option) (*UpdateUserPhoneConfigOutput, error)

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

See UpdateUserPhoneConfig 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateUserRoutingProfile

func (c *Connect) UpdateUserRoutingProfile(input *UpdateUserRoutingProfileInput) (*UpdateUserRoutingProfileOutput, error)

UpdateUserRoutingProfile API operation for Amazon Connect Service.

Assigns the specified routing profile to a user.

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

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserRoutingProfile for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile

UpdateUserRoutingProfileRequest

func (c *Connect) UpdateUserRoutingProfileRequest(input *UpdateUserRoutingProfileInput) (req *request.Request, output *UpdateUserRoutingProfileOutput)

UpdateUserRoutingProfileRequest generates a "aws/request.Request" representing the client's request for the UpdateUserRoutingProfile 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 UpdateUserRoutingProfile for more information on using the UpdateUserRoutingProfile 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 UpdateUserRoutingProfileRequest method. req, resp := client.UpdateUserRoutingProfileRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile

UpdateUserRoutingProfileWithContext

func (c *Connect) UpdateUserRoutingProfileWithContext(ctx aws.Context, input *UpdateUserRoutingProfileInput, opts ...request.Option) (*UpdateUserRoutingProfileOutput, error)

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

See UpdateUserRoutingProfile 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateUserSecurityProfiles

func (c *Connect) UpdateUserSecurityProfiles(input *UpdateUserSecurityProfilesInput) (*UpdateUserSecurityProfilesOutput, error)

UpdateUserSecurityProfiles API operation for Amazon Connect Service.

Updates the security profiles assigned to the user.

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

See the AWS API reference guide for Amazon Connect Service's API operation UpdateUserSecurityProfiles for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more of the parameters provided to the operation are not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.

  • ErrCodeThrottlingException "ThrottlingException" The throttling limit has been exceeded.

  • ErrCodeInternalServiceException "InternalServiceException" Request processing failed due to an error or failure with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles

UpdateUserSecurityProfilesRequest

func (c *Connect) UpdateUserSecurityProfilesRequest(input *UpdateUserSecurityProfilesInput) (req *request.Request, output *UpdateUserSecurityProfilesOutput)

UpdateUserSecurityProfilesRequest generates a "aws/request.Request" representing the client's request for the UpdateUserSecurityProfiles 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 UpdateUserSecurityProfiles for more information on using the UpdateUserSecurityProfiles 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 UpdateUserSecurityProfilesRequest method. req, resp := client.UpdateUserSecurityProfilesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles

UpdateUserSecurityProfilesWithContext

func (c *Connect) UpdateUserSecurityProfilesWithContext(ctx aws.Context, input *UpdateUserSecurityProfilesInput, opts ...request.Option) (*UpdateUserSecurityProfilesOutput, error)

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

See UpdateUserSecurityProfiles 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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: