connectparticipant

package
v1.40.30 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2021 License: Apache-2.0 Imports: 9 Imported by: 16

Documentation

Overview

Package connectparticipant provides the client and types for making API requests to Amazon Connect Participant Service.

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

See https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	// ArtifactStatusApproved is a ArtifactStatus enum value
	ArtifactStatusApproved = "APPROVED"

	// ArtifactStatusRejected is a ArtifactStatus enum value
	ArtifactStatusRejected = "REJECTED"

	// ArtifactStatusInProgress is a ArtifactStatus enum value
	ArtifactStatusInProgress = "IN_PROGRESS"
)
View Source 
const (
	// ChatItemTypeTyping is a ChatItemType enum value
	ChatItemTypeTyping = "TYPING"

	// ChatItemTypeParticipantJoined is a ChatItemType enum value
	ChatItemTypeParticipantJoined = "PARTICIPANT_JOINED"

	// ChatItemTypeParticipantLeft is a ChatItemType enum value
	ChatItemTypeParticipantLeft = "PARTICIPANT_LEFT"

	// ChatItemTypeChatEnded is a ChatItemType enum value
	ChatItemTypeChatEnded = "CHAT_ENDED"

	// ChatItemTypeTransferSucceeded is a ChatItemType enum value
	ChatItemTypeTransferSucceeded = "TRANSFER_SUCCEEDED"

	// ChatItemTypeTransferFailed is a ChatItemType enum value
	ChatItemTypeTransferFailed = "TRANSFER_FAILED"

	// ChatItemTypeMessage is a ChatItemType enum value
	ChatItemTypeMessage = "MESSAGE"

	// ChatItemTypeEvent is a ChatItemType enum value
	ChatItemTypeEvent = "EVENT"

	// ChatItemTypeAttachment is a ChatItemType enum value
	ChatItemTypeAttachment = "ATTACHMENT"

	// ChatItemTypeConnectionAck is a ChatItemType enum value
	ChatItemTypeConnectionAck = "CONNECTION_ACK"
)
View Source 
const (
	// ConnectionTypeWebsocket is a ConnectionType enum value
	ConnectionTypeWebsocket = "WEBSOCKET"

	// ConnectionTypeConnectionCredentials is a ConnectionType enum value
	ConnectionTypeConnectionCredentials = "CONNECTION_CREDENTIALS"
)
View Source 
const (
	// ParticipantRoleAgent is a ParticipantRole enum value
	ParticipantRoleAgent = "AGENT"

	// ParticipantRoleCustomer is a ParticipantRole enum value
	ParticipantRoleCustomer = "CUSTOMER"

	// ParticipantRoleSystem is a ParticipantRole enum value
	ParticipantRoleSystem = "SYSTEM"
)
View Source 
const (
	// ScanDirectionForward is a ScanDirection enum value
	ScanDirectionForward = "FORWARD"

	// ScanDirectionBackward is a ScanDirection enum value
	ScanDirectionBackward = "BACKWARD"
)
View Source 
const (
	// SortKeyDescending is a SortKey enum value
	SortKeyDescending = "DESCENDING"

	// SortKeyAscending is a SortKey enum value
	SortKeyAscending = "ASCENDING"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// An attachment with that identifier is already being uploaded.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// This exception occurs when there is an internal failure in the Amazon Connect
	// service.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The number of attachments per contact exceeds the quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by Amazon Connect.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "ConnectParticipant"  // Name of service.
	EndpointsID = "participant.connect" // ID to lookup a service endpoint with.
	ServiceID   = "ConnectParticipant"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ArtifactStatus_Values added in v1.36.13 

func ArtifactStatus_Values() []string

ArtifactStatus_Values returns all elements of the ArtifactStatus enum

func ChatItemType_Values added in v1.34.3 

func ChatItemType_Values() []string

ChatItemType_Values returns all elements of the ChatItemType enum

func ConnectionType_Values added in v1.34.3 

func ConnectionType_Values() []string

ConnectionType_Values returns all elements of the ConnectionType enum

func ParticipantRole_Values added in v1.34.3 

func ParticipantRole_Values() []string

ParticipantRole_Values returns all elements of the ParticipantRole enum

func ScanDirection_Values added in v1.34.3 

func ScanDirection_Values() []string

ScanDirection_Values returns all elements of the ScanDirection enum

func SortKey_Values added in v1.34.3 

func SortKey_Values() []string

SortKey_Values returns all elements of the SortKey enum

Types

type AccessDeniedException added in v1.28.0 

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

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

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation

type AttachmentItem added in v1.36.13 

type AttachmentItem struct {

	// A unique identifier for the attachment.
	AttachmentId *string `min:"1" type:"string"`

	// A case-sensitive name of the attachment being uploaded.
	AttachmentName *string `min:"1" type:"string"`

	// Describes the MIME file type of the attachment. For a list of supported file
	// types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits)
	// in the Amazon Connect Administrator Guide.
	ContentType *string `min:"1" type:"string"`

	// Status of the attachment.
	Status *string `type:"string" enum:"ArtifactStatus"`
	// contains filtered or unexported fields
}

The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.

func (AttachmentItem) GoString added in v1.36.13 

func (s AttachmentItem) GoString() string

GoString returns the string representation

func (*AttachmentItem) SetAttachmentId added in v1.36.13 

func (s *AttachmentItem) SetAttachmentId(v string) *AttachmentItem

SetAttachmentId sets the AttachmentId field's value.

func (*AttachmentItem) SetAttachmentName added in v1.36.13 

func (s *AttachmentItem) SetAttachmentName(v string) *AttachmentItem

SetAttachmentName sets the AttachmentName field's value.

func (*AttachmentItem) SetContentType added in v1.36.13 

func (s *AttachmentItem) SetContentType(v string) *AttachmentItem

SetContentType sets the ContentType field's value.

func (*AttachmentItem) SetStatus added in v1.36.13 

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

SetStatus sets the Status field's value.

func (AttachmentItem) String added in v1.36.13 

func (s AttachmentItem) String() string

String returns the string representation

type CompleteAttachmentUploadInput added in v1.36.13 

type CompleteAttachmentUploadInput struct {

	// A list of unique identifiers for the attachments.
	//
	// AttachmentIds is a required field
	AttachmentIds []*string `min:"1" type:"list" required:"true"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The authentication token associated with the participant's connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CompleteAttachmentUploadInput) GoString added in v1.36.13 

func (s CompleteAttachmentUploadInput) GoString() string

GoString returns the string representation

func (*CompleteAttachmentUploadInput) SetAttachmentIds added in v1.36.13 

func (s *CompleteAttachmentUploadInput) SetAttachmentIds(v []*string) *CompleteAttachmentUploadInput

SetAttachmentIds sets the AttachmentIds field's value.

func (*CompleteAttachmentUploadInput) SetClientToken added in v1.36.13 

func (s *CompleteAttachmentUploadInput) SetClientToken(v string) *CompleteAttachmentUploadInput

SetClientToken sets the ClientToken field's value.

func (*CompleteAttachmentUploadInput) SetConnectionToken added in v1.36.13 

func (s *CompleteAttachmentUploadInput) SetConnectionToken(v string) *CompleteAttachmentUploadInput

SetConnectionToken sets the ConnectionToken field's value.

func (CompleteAttachmentUploadInput) String added in v1.36.13 

func (s CompleteAttachmentUploadInput) String() string

String returns the string representation

func (*CompleteAttachmentUploadInput) Validate added in v1.36.13 

func (s *CompleteAttachmentUploadInput) Validate() error

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

type CompleteAttachmentUploadOutput added in v1.36.13 

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

func (CompleteAttachmentUploadOutput) GoString added in v1.36.13 

func (s CompleteAttachmentUploadOutput) GoString() string

GoString returns the string representation

func (CompleteAttachmentUploadOutput) String added in v1.36.13 

func (s CompleteAttachmentUploadOutput) String() string

String returns the string representation

type ConflictException added in v1.36.13 

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

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

An attachment with that identifier is already being uploaded.

func (*ConflictException) Code added in v1.36.13 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.36.13 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.36.13 

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message added in v1.36.13 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.36.13 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.36.13 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.36.13 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String added in v1.36.13 

func (s ConflictException) String() string

String returns the string representation

type ConnectParticipant 

type ConnectParticipant struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

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

// Create a ConnectParticipant client from just a session.
svc := connectparticipant.New(mySession)

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

func (*ConnectParticipant) CompleteAttachmentUpload added in v1.36.13 

func (c *ConnectParticipant) CompleteAttachmentUpload(input *CompleteAttachmentUploadInput) (*CompleteAttachmentUploadOutput, error)

CompleteAttachmentUpload API operation for Amazon Connect Participant Service.

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

  • ServiceQuotaExceededException The number of attachments per contact exceeds the quota.

  • ConflictException An attachment with that identifier is already being uploaded.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CompleteAttachmentUpload

func (*ConnectParticipant) CompleteAttachmentUploadRequest added in v1.36.13 

func (c *ConnectParticipant) CompleteAttachmentUploadRequest(input *CompleteAttachmentUploadInput) (req *request.Request, output *CompleteAttachmentUploadOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CompleteAttachmentUpload

func (*ConnectParticipant) CompleteAttachmentUploadWithContext added in v1.36.13 

func (c *ConnectParticipant) CompleteAttachmentUploadWithContext(ctx aws.Context, input *CompleteAttachmentUploadInput, opts ...request.Option) (*CompleteAttachmentUploadOutput, error)

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

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

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

func (*ConnectParticipant) CreateParticipantConnection 

func (c *ConnectParticipant) CreateParticipantConnection(input *CreateParticipantConnectionInput) (*CreateParticipantConnectionOutput, error)

CreateParticipantConnection API operation for Amazon Connect Participant Service.

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnection

func (*ConnectParticipant) CreateParticipantConnectionRequest 

func (c *ConnectParticipant) CreateParticipantConnectionRequest(input *CreateParticipantConnectionInput) (req *request.Request, output *CreateParticipantConnectionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnection

func (*ConnectParticipant) CreateParticipantConnectionWithContext 

func (c *ConnectParticipant) CreateParticipantConnectionWithContext(ctx aws.Context, input *CreateParticipantConnectionInput, opts ...request.Option) (*CreateParticipantConnectionOutput, error)

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

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

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

func (*ConnectParticipant) DisconnectParticipant 

func (c *ConnectParticipant) DisconnectParticipant(input *DisconnectParticipantInput) (*DisconnectParticipantOutput, error)

DisconnectParticipant API operation for Amazon Connect Participant Service.

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DisconnectParticipant

func (*ConnectParticipant) DisconnectParticipantRequest 

func (c *ConnectParticipant) DisconnectParticipantRequest(input *DisconnectParticipantInput) (req *request.Request, output *DisconnectParticipantOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DisconnectParticipant

func (*ConnectParticipant) DisconnectParticipantWithContext 

func (c *ConnectParticipant) DisconnectParticipantWithContext(ctx aws.Context, input *DisconnectParticipantInput, opts ...request.Option) (*DisconnectParticipantOutput, error)

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

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

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

func (*ConnectParticipant) GetAttachment added in v1.36.13 

func (c *ConnectParticipant) GetAttachment(input *GetAttachmentInput) (*GetAttachmentOutput, error)

GetAttachment API operation for Amazon Connect Participant Service.

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachment

func (*ConnectParticipant) GetAttachmentRequest added in v1.36.13 

func (c *ConnectParticipant) GetAttachmentRequest(input *GetAttachmentInput) (req *request.Request, output *GetAttachmentOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachment

func (*ConnectParticipant) GetAttachmentWithContext added in v1.36.13 

func (c *ConnectParticipant) GetAttachmentWithContext(ctx aws.Context, input *GetAttachmentInput, opts ...request.Option) (*GetAttachmentOutput, error)

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

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

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

func (*ConnectParticipant) GetTranscript 

func (c *ConnectParticipant) GetTranscript(input *GetTranscriptInput) (*GetTranscriptOutput, error)

GetTranscript API operation for Amazon Connect Participant Service.

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscript

func (*ConnectParticipant) GetTranscriptPages 

func (c *ConnectParticipant) GetTranscriptPages(input *GetTranscriptInput, fn func(*GetTranscriptOutput, bool) bool) error

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

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

func (*ConnectParticipant) GetTranscriptPagesWithContext 

func (c *ConnectParticipant) GetTranscriptPagesWithContext(ctx aws.Context, input *GetTranscriptInput, fn func(*GetTranscriptOutput, bool) bool, opts ...request.Option) error

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

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

func (*ConnectParticipant) GetTranscriptRequest 

func (c *ConnectParticipant) GetTranscriptRequest(input *GetTranscriptInput) (req *request.Request, output *GetTranscriptOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscript

func (*ConnectParticipant) GetTranscriptWithContext 

func (c *ConnectParticipant) GetTranscriptWithContext(ctx aws.Context, input *GetTranscriptInput, opts ...request.Option) (*GetTranscriptOutput, error)

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

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

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

func (*ConnectParticipant) SendEvent 

func (c *ConnectParticipant) SendEvent(input *SendEventInput) (*SendEventOutput, error)

SendEvent API operation for Amazon Connect Participant Service.

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEvent

func (*ConnectParticipant) SendEventRequest 

func (c *ConnectParticipant) SendEventRequest(input *SendEventInput) (req *request.Request, output *SendEventOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEvent

func (*ConnectParticipant) SendEventWithContext 

func (c *ConnectParticipant) SendEventWithContext(ctx aws.Context, input *SendEventInput, opts ...request.Option) (*SendEventOutput, error)

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

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

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

func (*ConnectParticipant) SendMessage 

func (c *ConnectParticipant) SendMessage(input *SendMessageInput) (*SendMessageOutput, error)

SendMessage API operation for Amazon Connect Participant Service.

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendMessage

func (*ConnectParticipant) SendMessageRequest 

func (c *ConnectParticipant) SendMessageRequest(input *SendMessageInput) (req *request.Request, output *SendMessageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendMessage

func (*ConnectParticipant) SendMessageWithContext 

func (c *ConnectParticipant) SendMessageWithContext(ctx aws.Context, input *SendMessageInput, opts ...request.Option) (*SendMessageOutput, error)

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

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

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

func (*ConnectParticipant) StartAttachmentUpload added in v1.36.13 

func (c *ConnectParticipant) StartAttachmentUpload(input *StartAttachmentUploadInput) (*StartAttachmentUploadOutput, error)

StartAttachmentUpload API operation for Amazon Connect Participant Service.

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException This exception occurs when there is an internal failure in the Amazon Connect service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by Amazon Connect.

  • ServiceQuotaExceededException The number of attachments per contact exceeds the quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/StartAttachmentUpload

func (*ConnectParticipant) StartAttachmentUploadRequest added in v1.36.13 

func (c *ConnectParticipant) StartAttachmentUploadRequest(input *StartAttachmentUploadInput) (req *request.Request, output *StartAttachmentUploadOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/StartAttachmentUpload

func (*ConnectParticipant) StartAttachmentUploadWithContext added in v1.36.13 

func (c *ConnectParticipant) StartAttachmentUploadWithContext(ctx aws.Context, input *StartAttachmentUploadInput, opts ...request.Option) (*StartAttachmentUploadOutput, error)

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

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

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

type ConnectionCredentials 

type ConnectionCredentials struct {

	// The connection token.
	ConnectionToken *string `min:"1" type:"string"`

	// The expiration of the token.
	//
	// It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
	// 2019-11-08T02:41:28.172Z.
	Expiry *string `type:"string"`
	// contains filtered or unexported fields
}

Connection credentials.

func (ConnectionCredentials) GoString 

func (s ConnectionCredentials) GoString() string

GoString returns the string representation

func (*ConnectionCredentials) SetConnectionToken 

func (s *ConnectionCredentials) SetConnectionToken(v string) *ConnectionCredentials

SetConnectionToken sets the ConnectionToken field's value.

func (*ConnectionCredentials) SetExpiry 

func (s *ConnectionCredentials) SetExpiry(v string) *ConnectionCredentials

SetExpiry sets the Expiry field's value.

func (ConnectionCredentials) String 

func (s ConnectionCredentials) String() string

String returns the string representation

type CreateParticipantConnectionInput 

type CreateParticipantConnectionInput struct {

	// This is a header parameter.
	//
	// The Participant Token as obtained from StartChatContact (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html)
	// API response.
	//
	// ParticipantToken is a required field
	ParticipantToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`

	// Type of connection information required.
	//
	// Type is a required field
	Type []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateParticipantConnectionInput) GoString 

func (s CreateParticipantConnectionInput) GoString() string

GoString returns the string representation

func (*CreateParticipantConnectionInput) SetParticipantToken 

func (s *CreateParticipantConnectionInput) SetParticipantToken(v string) *CreateParticipantConnectionInput

SetParticipantToken sets the ParticipantToken field's value.

func (*CreateParticipantConnectionInput) SetType 

func (s *CreateParticipantConnectionInput) SetType(v []*string) *CreateParticipantConnectionInput

SetType sets the Type field's value.

func (CreateParticipantConnectionInput) String 

func (s CreateParticipantConnectionInput) String() string

String returns the string representation

func (*CreateParticipantConnectionInput) Validate 

func (s *CreateParticipantConnectionInput) Validate() error

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

type CreateParticipantConnectionOutput 

type CreateParticipantConnectionOutput struct {

	// Creates the participant's connection credentials. The authentication token
	// associated with the participant's connection.
	ConnectionCredentials *ConnectionCredentials `type:"structure"`

	// Creates the participant's websocket connection.
	Websocket *Websocket `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateParticipantConnectionOutput) GoString 

func (s CreateParticipantConnectionOutput) GoString() string

GoString returns the string representation

func (*CreateParticipantConnectionOutput) SetConnectionCredentials 

func (s *CreateParticipantConnectionOutput) SetConnectionCredentials(v *ConnectionCredentials) *CreateParticipantConnectionOutput

SetConnectionCredentials sets the ConnectionCredentials field's value.

func (*CreateParticipantConnectionOutput) SetWebsocket 

func (s *CreateParticipantConnectionOutput) SetWebsocket(v *Websocket) *CreateParticipantConnectionOutput

SetWebsocket sets the Websocket field's value.

func (CreateParticipantConnectionOutput) String 

func (s CreateParticipantConnectionOutput) String() string

String returns the string representation

type DisconnectParticipantInput 

type DisconnectParticipantInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The authentication token associated with the participant's connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisconnectParticipantInput) GoString 

func (s DisconnectParticipantInput) GoString() string

GoString returns the string representation

func (*DisconnectParticipantInput) SetClientToken 

func (s *DisconnectParticipantInput) SetClientToken(v string) *DisconnectParticipantInput

SetClientToken sets the ClientToken field's value.

func (*DisconnectParticipantInput) SetConnectionToken 

func (s *DisconnectParticipantInput) SetConnectionToken(v string) *DisconnectParticipantInput

SetConnectionToken sets the ConnectionToken field's value.

func (DisconnectParticipantInput) String 

func (s DisconnectParticipantInput) String() string

String returns the string representation

func (*DisconnectParticipantInput) Validate 

func (s *DisconnectParticipantInput) Validate() error

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

type DisconnectParticipantOutput 

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

func (DisconnectParticipantOutput) GoString 

func (s DisconnectParticipantOutput) GoString() string

GoString returns the string representation

func (DisconnectParticipantOutput) String 

func (s DisconnectParticipantOutput) String() string

String returns the string representation

type GetAttachmentInput added in v1.36.13 

type GetAttachmentInput struct {

	// A unique identifier for the attachment.
	//
	// AttachmentId is a required field
	AttachmentId *string `min:"1" type:"string" required:"true"`

	// The authentication token associated with the participant's connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAttachmentInput) GoString added in v1.36.13 

func (s GetAttachmentInput) GoString() string

GoString returns the string representation

func (*GetAttachmentInput) SetAttachmentId added in v1.36.13 

func (s *GetAttachmentInput) SetAttachmentId(v string) *GetAttachmentInput

SetAttachmentId sets the AttachmentId field's value.

func (*GetAttachmentInput) SetConnectionToken added in v1.36.13 

func (s *GetAttachmentInput) SetConnectionToken(v string) *GetAttachmentInput

SetConnectionToken sets the ConnectionToken field's value.

func (GetAttachmentInput) String added in v1.36.13 

func (s GetAttachmentInput) String() string

String returns the string representation

func (*GetAttachmentInput) Validate added in v1.36.13 

func (s *GetAttachmentInput) Validate() error

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

type GetAttachmentOutput added in v1.36.13 

type GetAttachmentOutput struct {

	// The pre-signed URL using which file would be downloaded from Amazon S3 by
	// the API caller.
	Url *string `min:"1" type:"string"`

	// The expiration time of the URL in ISO timestamp. It's specified in ISO 8601
	// format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
	UrlExpiry *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetAttachmentOutput) GoString added in v1.36.13 

func (s GetAttachmentOutput) GoString() string

GoString returns the string representation

func (*GetAttachmentOutput) SetUrl added in v1.36.13 

func (s *GetAttachmentOutput) SetUrl(v string) *GetAttachmentOutput

SetUrl sets the Url field's value.

func (*GetAttachmentOutput) SetUrlExpiry added in v1.36.13 

func (s *GetAttachmentOutput) SetUrlExpiry(v string) *GetAttachmentOutput

SetUrlExpiry sets the UrlExpiry field's value.

func (GetAttachmentOutput) String added in v1.36.13 

func (s GetAttachmentOutput) String() string

String returns the string representation

type GetTranscriptInput 

type GetTranscriptInput struct {

	// The authentication token associated with the participant's connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`

	// The contactId from the current contact chain for which transcript is needed.
	ContactId *string `min:"1" type:"string"`

	// The maximum number of results to return in the page. Default: 10.
	MaxResults *int64 `type:"integer"`

	// The pagination token. Use the value returned previously in the next subsequent
	// request to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The direction from StartPosition from which to retrieve message. Default:
	// BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
	ScanDirection *string `type:"string" enum:"ScanDirection"`

	// The sort order for the records. Default: DESCENDING.
	SortOrder *string `type:"string" enum:"SortKey"`

	// A filtering option for where to start.
	StartPosition *StartPosition `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTranscriptInput) GoString 

func (s GetTranscriptInput) GoString() string

GoString returns the string representation

func (*GetTranscriptInput) SetConnectionToken 

func (s *GetTranscriptInput) SetConnectionToken(v string) *GetTranscriptInput

SetConnectionToken sets the ConnectionToken field's value.

func (*GetTranscriptInput) SetContactId 

func (s *GetTranscriptInput) SetContactId(v string) *GetTranscriptInput

SetContactId sets the ContactId field's value.

func (*GetTranscriptInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*GetTranscriptInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetTranscriptInput) SetScanDirection 

func (s *GetTranscriptInput) SetScanDirection(v string) *GetTranscriptInput

SetScanDirection sets the ScanDirection field's value.

func (*GetTranscriptInput) SetSortOrder 

func (s *GetTranscriptInput) SetSortOrder(v string) *GetTranscriptInput

SetSortOrder sets the SortOrder field's value.

func (*GetTranscriptInput) SetStartPosition 

func (s *GetTranscriptInput) SetStartPosition(v *StartPosition) *GetTranscriptInput

SetStartPosition sets the StartPosition field's value.

func (GetTranscriptInput) String 

func (s GetTranscriptInput) String() string

String returns the string representation

func (*GetTranscriptInput) Validate 

func (s *GetTranscriptInput) Validate() error

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

type GetTranscriptOutput 

type GetTranscriptOutput struct {

	// The initial contact ID for the contact.
	InitialContactId *string `min:"1" type:"string"`

	// The pagination token. Use the value returned previously in the next subsequent
	// request to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The list of messages in the session.
	Transcript []*Item `type:"list"`
	// contains filtered or unexported fields
}

func (GetTranscriptOutput) GoString 

func (s GetTranscriptOutput) GoString() string

GoString returns the string representation

func (*GetTranscriptOutput) SetInitialContactId 

func (s *GetTranscriptOutput) SetInitialContactId(v string) *GetTranscriptOutput

SetInitialContactId sets the InitialContactId field's value.

func (*GetTranscriptOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetTranscriptOutput) SetTranscript 

func (s *GetTranscriptOutput) SetTranscript(v []*Item) *GetTranscriptOutput

SetTranscript sets the Transcript field's value.

func (GetTranscriptOutput) String 

func (s GetTranscriptOutput) String() string

String returns the string representation

type InternalServerException added in v1.28.0 

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

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

This exception occurs when there is an internal failure in the Amazon Connect service.

func (*InternalServerException) Code added in v1.28.0 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message added in v1.28.0 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String added in v1.28.0 

func (s InternalServerException) String() string

String returns the string representation

type Item 

type Item struct {

	// The time when the message or event was sent.
	//
	// It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
	// 2019-11-08T02:41:28.172Z.
	AbsoluteTime *string `min:"1" type:"string"`

	// Provides information about the attachments.
	Attachments []*AttachmentItem `type:"list"`

	// The content of the message or event.
	Content *string `min:"1" type:"string"`

	// The type of content of the item.
	ContentType *string `min:"1" type:"string"`

	// The chat display name of the sender.
	DisplayName *string `min:"1" type:"string"`

	// The ID of the item.
	Id *string `min:"1" type:"string"`

	// The ID of the sender in the session.
	ParticipantId *string `min:"1" type:"string"`

	// The role of the sender. For example, is it a customer, agent, or system.
	ParticipantRole *string `type:"string" enum:"ParticipantRole"`

	// Type of the item: message or event.
	Type *string `type:"string" enum:"ChatItemType"`
	// contains filtered or unexported fields
}

An item - message or event - that has been sent.

func (Item) GoString 

func (s Item) GoString() string

GoString returns the string representation

func (*Item) SetAbsoluteTime 

func (s *Item) SetAbsoluteTime(v string) *Item

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*Item) SetAttachments added in v1.36.13 

func (s *Item) SetAttachments(v []*AttachmentItem) *Item

SetAttachments sets the Attachments field's value.

func (*Item) SetContent 

func (s *Item) SetContent(v string) *Item

SetContent sets the Content field's value.

func (*Item) SetContentType 

func (s *Item) SetContentType(v string) *Item

SetContentType sets the ContentType field's value.

func (*Item) SetDisplayName 

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

SetDisplayName sets the DisplayName field's value.

func (*Item) SetId 

func (s *Item) SetId(v string) *Item

SetId sets the Id field's value.

func (*Item) SetParticipantId 

func (s *Item) SetParticipantId(v string) *Item

SetParticipantId sets the ParticipantId field's value.

func (*Item) SetParticipantRole 

func (s *Item) SetParticipantRole(v string) *Item

SetParticipantRole sets the ParticipantRole field's value.

func (*Item) SetType 

func (s *Item) SetType(v string) *Item

SetType sets the Type field's value.

func (Item) String 

func (s Item) String() string

String returns the string representation

type SendEventInput 

type SendEventInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The authentication token associated with the participant's connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`

	// The content of the event to be sent (for example, message text). This is
	// not yet supported.
	Content *string `min:"1" type:"string"`

	// The content type of the request. Supported types are:
	//
	//    * application/vnd.amazonaws.connect.event.typing
	//
	//    * application/vnd.amazonaws.connect.event.connection.acknowledged
	//
	// ContentType is a required field
	ContentType *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendEventInput) GoString 

func (s SendEventInput) GoString() string

GoString returns the string representation

func (*SendEventInput) SetClientToken 

func (s *SendEventInput) SetClientToken(v string) *SendEventInput

SetClientToken sets the ClientToken field's value.

func (*SendEventInput) SetConnectionToken 

func (s *SendEventInput) SetConnectionToken(v string) *SendEventInput

SetConnectionToken sets the ConnectionToken field's value.

func (*SendEventInput) SetContent 

func (s *SendEventInput) SetContent(v string) *SendEventInput

SetContent sets the Content field's value.

func (*SendEventInput) SetContentType 

func (s *SendEventInput) SetContentType(v string) *SendEventInput

SetContentType sets the ContentType field's value.

func (SendEventInput) String 

func (s SendEventInput) String() string

String returns the string representation

func (*SendEventInput) Validate 

func (s *SendEventInput) Validate() error

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

type SendEventOutput 

type SendEventOutput struct {

	// The time when the event was sent.
	//
	// It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
	// 2019-11-08T02:41:28.172Z.
	AbsoluteTime *string `min:"1" type:"string"`

	// The ID of the response.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SendEventOutput) GoString 

func (s SendEventOutput) GoString() string

GoString returns the string representation

func (*SendEventOutput) SetAbsoluteTime 

func (s *SendEventOutput) SetAbsoluteTime(v string) *SendEventOutput

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*SendEventOutput) SetId 

func (s *SendEventOutput) SetId(v string) *SendEventOutput

SetId sets the Id field's value.

func (SendEventOutput) String 

func (s SendEventOutput) String() string

String returns the string representation

type SendMessageInput 

type SendMessageInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The authentication token associated with the connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`

	// The content of the message.
	//
	// Content is a required field
	Content *string `min:"1" type:"string" required:"true"`

	// The type of the content. Supported types are text/plain.
	//
	// ContentType is a required field
	ContentType *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessageInput) GoString 

func (s SendMessageInput) GoString() string

GoString returns the string representation

func (*SendMessageInput) SetClientToken 

func (s *SendMessageInput) SetClientToken(v string) *SendMessageInput

SetClientToken sets the ClientToken field's value.

func (*SendMessageInput) SetConnectionToken 

func (s *SendMessageInput) SetConnectionToken(v string) *SendMessageInput

SetConnectionToken sets the ConnectionToken field's value.

func (*SendMessageInput) SetContent 

func (s *SendMessageInput) SetContent(v string) *SendMessageInput

SetContent sets the Content field's value.

func (*SendMessageInput) SetContentType 

func (s *SendMessageInput) SetContentType(v string) *SendMessageInput

SetContentType sets the ContentType field's value.

func (SendMessageInput) String 

func (s SendMessageInput) String() string

String returns the string representation

func (*SendMessageInput) Validate 

func (s *SendMessageInput) Validate() error

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

type SendMessageOutput 

type SendMessageOutput struct {

	// The time when the message was sent.
	//
	// It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
	// 2019-11-08T02:41:28.172Z.
	AbsoluteTime *string `min:"1" type:"string"`

	// The ID of the message.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SendMessageOutput) GoString 

func (s SendMessageOutput) GoString() string

GoString returns the string representation

func (*SendMessageOutput) SetAbsoluteTime 

func (s *SendMessageOutput) SetAbsoluteTime(v string) *SendMessageOutput

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*SendMessageOutput) SetId 

func (s *SendMessageOutput) SetId(v string) *SendMessageOutput

SetId sets the Id field's value.

func (SendMessageOutput) String 

func (s SendMessageOutput) String() string

String returns the string representation

type ServiceQuotaExceededException added in v1.36.13 

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

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

The number of attachments per contact exceeds the quota.

func (*ServiceQuotaExceededException) Code added in v1.36.13 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.36.13 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.36.13 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message added in v1.36.13 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.36.13 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.36.13 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.36.13 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String added in v1.36.13 

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type StartAttachmentUploadInput added in v1.36.13 

type StartAttachmentUploadInput struct {

	// A case-sensitive name of the attachment being uploaded.
	//
	// AttachmentName is a required field
	AttachmentName *string `min:"1" type:"string" required:"true"`

	// The size of the attachment in bytes.
	//
	// AttachmentSizeInBytes is a required field
	AttachmentSizeInBytes *int64 `min:"1" type:"long" required:"true"`

	// A unique case sensitive identifier to support idempotency of request.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The authentication token associated with the participant's connection.
	//
	// ConnectionToken is a required field
	ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`

	// Describes the MIME file type of the attachment. For a list of supported file
	// types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits)
	// in the Amazon Connect Administrator Guide.
	//
	// ContentType is a required field
	ContentType *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartAttachmentUploadInput) GoString added in v1.36.13 

func (s StartAttachmentUploadInput) GoString() string

GoString returns the string representation

func (*StartAttachmentUploadInput) SetAttachmentName added in v1.36.13 

func (s *StartAttachmentUploadInput) SetAttachmentName(v string) *StartAttachmentUploadInput

SetAttachmentName sets the AttachmentName field's value.

func (*StartAttachmentUploadInput) SetAttachmentSizeInBytes added in v1.36.13 

func (s *StartAttachmentUploadInput) SetAttachmentSizeInBytes(v int64) *StartAttachmentUploadInput

SetAttachmentSizeInBytes sets the AttachmentSizeInBytes field's value.

func (*StartAttachmentUploadInput) SetClientToken added in v1.36.13 

func (s *StartAttachmentUploadInput) SetClientToken(v string) *StartAttachmentUploadInput

SetClientToken sets the ClientToken field's value.

func (*StartAttachmentUploadInput) SetConnectionToken added in v1.36.13 

func (s *StartAttachmentUploadInput) SetConnectionToken(v string) *StartAttachmentUploadInput

SetConnectionToken sets the ConnectionToken field's value.

func (*StartAttachmentUploadInput) SetContentType added in v1.36.13 

func (s *StartAttachmentUploadInput) SetContentType(v string) *StartAttachmentUploadInput

SetContentType sets the ContentType field's value.

func (StartAttachmentUploadInput) String added in v1.36.13 

func (s StartAttachmentUploadInput) String() string

String returns the string representation

func (*StartAttachmentUploadInput) Validate added in v1.36.13 

func (s *StartAttachmentUploadInput) Validate() error

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

type StartAttachmentUploadOutput added in v1.36.13 

type StartAttachmentUploadOutput struct {

	// A unique identifier for the attachment.
	AttachmentId *string `min:"1" type:"string"`

	// Fields to be used while uploading the attachment.
	UploadMetadata *UploadMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (StartAttachmentUploadOutput) GoString added in v1.36.13 

func (s StartAttachmentUploadOutput) GoString() string

GoString returns the string representation

func (*StartAttachmentUploadOutput) SetAttachmentId added in v1.36.13 

func (s *StartAttachmentUploadOutput) SetAttachmentId(v string) *StartAttachmentUploadOutput

SetAttachmentId sets the AttachmentId field's value.

func (*StartAttachmentUploadOutput) SetUploadMetadata added in v1.36.13 

func (s *StartAttachmentUploadOutput) SetUploadMetadata(v *UploadMetadata) *StartAttachmentUploadOutput

SetUploadMetadata sets the UploadMetadata field's value.

func (StartAttachmentUploadOutput) String added in v1.36.13 

func (s StartAttachmentUploadOutput) String() string

String returns the string representation

type StartPosition 

type StartPosition struct {

	// The time in ISO format where to start.
	//
	// It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
	// 2019-11-08T02:41:28.172Z.
	AbsoluteTime *string `min:"1" type:"string"`

	// The ID of the message or event where to start.
	Id *string `min:"1" type:"string"`

	// The start position of the most recent message where you want to start.
	MostRecent *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A filtering option for where to start. For example, if you sent 100 messages, start with message 50.

func (StartPosition) GoString 

func (s StartPosition) GoString() string

GoString returns the string representation

func (*StartPosition) SetAbsoluteTime 

func (s *StartPosition) SetAbsoluteTime(v string) *StartPosition

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*StartPosition) SetId 

func (s *StartPosition) SetId(v string) *StartPosition

SetId sets the Id field's value.

func (*StartPosition) SetMostRecent 

func (s *StartPosition) SetMostRecent(v int64) *StartPosition

SetMostRecent sets the MostRecent field's value.

func (StartPosition) String 

func (s StartPosition) String() string

String returns the string representation

func (*StartPosition) Validate 

func (s *StartPosition) Validate() error

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

type ThrottlingException added in v1.28.0 

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

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

The request was denied due to request throttling.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation

type UploadMetadata added in v1.36.13 

type UploadMetadata struct {

	// The headers to be provided while uploading the file to the URL.
	HeadersToInclude map[string]*string `type:"map"`

	// The pre-signed URL using which file would be downloaded from Amazon S3 by
	// the API caller.
	Url *string `min:"1" type:"string"`

	// The expiration time of the URL in ISO timestamp. It's specified in ISO 8601
	// format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
	UrlExpiry *string `type:"string"`
	// contains filtered or unexported fields
}

Fields to be used while uploading the attachment.

func (UploadMetadata) GoString added in v1.36.13 

func (s UploadMetadata) GoString() string

GoString returns the string representation

func (*UploadMetadata) SetHeadersToInclude added in v1.36.13 

func (s *UploadMetadata) SetHeadersToInclude(v map[string]*string) *UploadMetadata

SetHeadersToInclude sets the HeadersToInclude field's value.

func (*UploadMetadata) SetUrl added in v1.36.13 

func (s *UploadMetadata) SetUrl(v string) *UploadMetadata

SetUrl sets the Url field's value.

func (*UploadMetadata) SetUrlExpiry added in v1.36.13 

func (s *UploadMetadata) SetUrlExpiry(v string) *UploadMetadata

SetUrlExpiry sets the UrlExpiry field's value.

func (UploadMetadata) String added in v1.36.13 

func (s UploadMetadata) String() string

String returns the string representation

type ValidationException added in v1.28.0 

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

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

The input fails to satisfy the constraints specified by Amazon Connect.

func (*ValidationException) Code added in v1.28.0 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.28.0 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message added in v1.28.0 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.28.0 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.28.0 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.28.0 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String added in v1.28.0 

func (s ValidationException) String() string

String returns the string representation

type Websocket 

type Websocket struct {

	// The URL expiration timestamp in ISO date format.
	//
	// It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
	// 2019-11-08T02:41:28.172Z.
	ConnectionExpiry *string `type:"string"`

	// The URL of the websocket.
	Url *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The websocket for the participant's connection.

func (Websocket) GoString 

func (s Websocket) GoString() string

GoString returns the string representation

func (*Websocket) SetConnectionExpiry 

func (s *Websocket) SetConnectionExpiry(v string) *Websocket

SetConnectionExpiry sets the ConnectionExpiry field's value.

func (*Websocket) SetUrl 

func (s *Websocket) SetUrl(v string) *Websocket

SetUrl sets the Url field's value.

func (Websocket) String 

func (s Websocket) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package connectparticipantiface provides an interface to enable mocking the Amazon Connect Participant Service service client for testing your code.
 Package connectparticipantiface provides an interface to enable mocking the Amazon Connect Participant Service service client for testing your code.

Jump to

Keyboard shortcuts

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