func ArtifactStatus_Values() []string
ArtifactStatus_Values returns all elements of the ArtifactStatus enum
func ChatItemType_Values() []string
ChatItemType_Values returns all elements of the ChatItemType enum
func ConnectionType_Values() []string
ConnectionType_Values returns all elements of the ConnectionType enum
func ParticipantRole_Values() []string
ParticipantRole_Values returns all elements of the ParticipantRole enum
func ResourceType_Values() []string
ResourceType_Values returns all elements of the ResourceType enum
func ScanDirection_Values() []string
ScanDirection_Values returns all elements of the ScanDirection enum
func SortKey_Values() []string
SortKey_Values returns all elements of the SortKey enum
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 (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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/feature-limits.html)
// 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 (s AttachmentItem) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AttachmentItem) SetAttachmentId(v string) *AttachmentItem
SetAttachmentId sets the AttachmentId field's value.
func (s *AttachmentItem) SetAttachmentName(v string) *AttachmentItem
SetAttachmentName sets the AttachmentName field's value.
func (s *AttachmentItem) SetContentType(v string) *AttachmentItem
SetContentType sets the ContentType field's value.
func (s *AttachmentItem) SetStatus(v string) *AttachmentItem
SetStatus sets the Status field's value.
func (s AttachmentItem) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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. If not provided, the Amazon Web Services SDK populates this
// field. For more information about idempotency, see Making retries safe with
// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
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 (s CompleteAttachmentUploadInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CompleteAttachmentUploadInput) SetAttachmentIds(v []*string) *CompleteAttachmentUploadInput
SetAttachmentIds sets the AttachmentIds field's value.
func (s *CompleteAttachmentUploadInput) SetClientToken(v string) *CompleteAttachmentUploadInput
SetClientToken sets the ClientToken field's value.
func (s *CompleteAttachmentUploadInput) SetConnectionToken(v string) *CompleteAttachmentUploadInput
SetConnectionToken sets the ConnectionToken field's value.
func (s CompleteAttachmentUploadInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CompleteAttachmentUploadInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompleteAttachmentUploadOutput struct {
// contains filtered or unexported fields
}
func (s CompleteAttachmentUploadOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s CompleteAttachmentUploadOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" min:"1" type:"string"`
// contains filtered or unexported fields
}
The requested operation conflicts with the current state of a service resource associated with the request.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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(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 (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. A conflict exception is thrown when an attachment with that identifier is already being uploaded.
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 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 The requested operation conflicts with the current state of a service resource associated with the request.
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)
}
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 (c *ConnectParticipant) CreateParticipantConnection(input *CreateParticipantConnectionInput) (*CreateParticipantConnectionOutput, error)
CreateParticipantConnection API operation for Amazon Connect Participant Service.
Creates the participant's connection.
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.
Message streaming support: This API can also be used together with the StartContactStreaming (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming (https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) in the Amazon Connect Administrator Guide.
Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) in the Amazon Connect Administrator Guide.
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.
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)
}
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 (c *ConnectParticipant) DescribeView(input *DescribeViewInput) (*DescribeViewOutput, error)
DescribeView API operation for Amazon Connect Participant Service.
Retrieves the view for the specified view token.
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 DescribeView 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.
ResourceNotFoundException The resource was not found.
ValidationException The input fails to satisfy the constraints specified by Amazon Connect.
func (c *ConnectParticipant) DescribeViewRequest(input *DescribeViewInput) (req *request.Request, output *DescribeViewOutput)
DescribeViewRequest generates a "aws/request.Request" representing the client's request for the DescribeView 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 DescribeView for more information on using the DescribeView 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 DescribeViewRequest method.
req, resp := client.DescribeViewRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *ConnectParticipant) DescribeViewWithContext(ctx aws.Context, input *DescribeViewInput, opts ...request.Option) (*DescribeViewOutput, error)
DescribeViewWithContext is the same as DescribeView with the addition of the ability to pass a context and additional request options.
See DescribeView 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 (c *ConnectParticipant) DisconnectParticipant(input *DisconnectParticipantInput) (*DisconnectParticipantOutput, error)
DisconnectParticipant API operation for Amazon Connect Participant Service.
Disconnects a participant.
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.
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)
}
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 (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.
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 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.
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)
}
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 (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. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html).
If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:
application/vnd.amazonaws.connect.event.participant.left
application/vnd.amazonaws.connect.event.participant.joined
application/vnd.amazonaws.connect.event.chat.ended
application/vnd.amazonaws.connect.event.transfer.succeeded
application/vnd.amazonaws.connect.event.transfer.failed
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.
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 (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 (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)
}
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 (c *ConnectParticipant) SendEvent(input *SendEventInput) (*SendEventOutput, error)
SendEvent API operation for Amazon Connect Participant Service.
The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType will no longer be supported starting December 31, 2024. This event has been migrated to the CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API using the ConnectParticipant field.
Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.
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.
ConflictException The requested operation conflicts with the current state of a service resource associated with the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEvent
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 (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 (c *ConnectParticipant) SendMessage(input *SendMessageInput) (*SendMessageOutput, error)
SendMessage API operation for Amazon Connect Participant Service.
Sends a message.
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.
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)
}
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 (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.
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 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.
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)
}
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 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 (s ConnectionCredentials) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConnectionCredentials) SetConnectionToken(v string) *ConnectionCredentials
SetConnectionToken sets the ConnectionToken field's value.
func (s *ConnectionCredentials) SetExpiry(v string) *ConnectionCredentials
SetExpiry sets the Expiry field's value.
func (s ConnectionCredentials) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateParticipantConnectionInput struct {
// Amazon Connect Participant is used to mark the participant as connected for
// customer participant in message streaming, as well as for agent or manager
// participant in non-streaming chats.
ConnectParticipant *bool `type:"boolean"`
// This is a header parameter.
//
// The ParticipantToken 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. If you need CONNECTION_CREDENTIALS
// along with marking participant as connected, pass CONNECTION_CREDENTIALS
// in Type.
Type []*string `min:"1" type:"list" enum:"ConnectionType"`
// contains filtered or unexported fields
}
func (s CreateParticipantConnectionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateParticipantConnectionInput) SetConnectParticipant(v bool) *CreateParticipantConnectionInput
SetConnectParticipant sets the ConnectParticipant field's value.
func (s *CreateParticipantConnectionInput) SetParticipantToken(v string) *CreateParticipantConnectionInput
SetParticipantToken sets the ParticipantToken field's value.
func (s *CreateParticipantConnectionInput) SetType(v []*string) *CreateParticipantConnectionInput
SetType sets the Type field's value.
func (s CreateParticipantConnectionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateParticipantConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s CreateParticipantConnectionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateParticipantConnectionOutput) SetConnectionCredentials(v *ConnectionCredentials) *CreateParticipantConnectionOutput
SetConnectionCredentials sets the ConnectionCredentials field's value.
func (s *CreateParticipantConnectionOutput) SetWebsocket(v *Websocket) *CreateParticipantConnectionOutput
SetWebsocket sets the Websocket field's value.
func (s CreateParticipantConnectionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeViewInput struct {
// The connection token.
//
// ConnectionToken is a required field
ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"`
// An encrypted token originating from the interactive message of a ShowView
// block operation. Represents the desired view.
//
// ViewToken is a required field
ViewToken *string `location:"uri" locationName:"ViewToken" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeViewInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeViewInput) SetConnectionToken(v string) *DescribeViewInput
SetConnectionToken sets the ConnectionToken field's value.
func (s *DescribeViewInput) SetViewToken(v string) *DescribeViewInput
SetViewToken sets the ViewToken field's value.
func (s DescribeViewInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeViewInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeViewOutput struct {
// A view resource object. Contains metadata and content necessary to render
// the view.
View *View `type:"structure"`
// contains filtered or unexported fields
}
func (s DescribeViewOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeViewOutput) SetView(v *View) *DescribeViewOutput
SetView sets the View field's value.
func (s DescribeViewOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DisconnectParticipantInput struct {
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. If not provided, the Amazon Web Services SDK populates this
// field. For more information about idempotency, see Making retries safe with
// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
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 (s DisconnectParticipantInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisconnectParticipantInput) SetClientToken(v string) *DisconnectParticipantInput
SetClientToken sets the ClientToken field's value.
func (s *DisconnectParticipantInput) SetConnectionToken(v string) *DisconnectParticipantInput
SetConnectionToken sets the ConnectionToken field's value.
func (s DisconnectParticipantInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisconnectParticipantInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisconnectParticipantOutput struct {
// contains filtered or unexported fields
}
func (s DisconnectParticipantOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DisconnectParticipantOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s GetAttachmentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAttachmentInput) SetAttachmentId(v string) *GetAttachmentInput
SetAttachmentId sets the AttachmentId field's value.
func (s *GetAttachmentInput) SetConnectionToken(v string) *GetAttachmentInput
SetConnectionToken sets the ConnectionToken field's value.
func (s GetAttachmentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAttachmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAttachmentOutput struct {
// This is the pre-signed URL that can be used for uploading the file to Amazon
// S3 when used in response to StartAttachmentUpload (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html).
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 (s GetAttachmentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAttachmentOutput) SetUrl(v string) *GetAttachmentOutput
SetUrl sets the Url field's value.
func (s *GetAttachmentOutput) SetUrlExpiry(v string) *GetAttachmentOutput
SetUrlExpiry sets the UrlExpiry field's value.
func (s GetAttachmentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s GetTranscriptInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetTranscriptInput) SetConnectionToken(v string) *GetTranscriptInput
SetConnectionToken sets the ConnectionToken field's value.
func (s *GetTranscriptInput) SetContactId(v string) *GetTranscriptInput
SetContactId sets the ContactId field's value.
func (s *GetTranscriptInput) SetMaxResults(v int64) *GetTranscriptInput
SetMaxResults sets the MaxResults field's value.
func (s *GetTranscriptInput) SetNextToken(v string) *GetTranscriptInput
SetNextToken sets the NextToken field's value.
func (s *GetTranscriptInput) SetScanDirection(v string) *GetTranscriptInput
SetScanDirection sets the ScanDirection field's value.
func (s *GetTranscriptInput) SetSortOrder(v string) *GetTranscriptInput
SetSortOrder sets the SortOrder field's value.
func (s *GetTranscriptInput) SetStartPosition(v *StartPosition) *GetTranscriptInput
SetStartPosition sets the StartPosition field's value.
func (s GetTranscriptInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetTranscriptInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetTranscriptOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetTranscriptOutput) SetInitialContactId(v string) *GetTranscriptOutput
SetInitialContactId sets the InitialContactId field's value.
func (s *GetTranscriptOutput) SetNextToken(v string) *GetTranscriptOutput
SetNextToken sets the NextToken field's value.
func (s *GetTranscriptOutput) SetTranscript(v []*Item) *GetTranscriptOutput
SetTranscript sets the Transcript field's value.
func (s GetTranscriptOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 contactId on which the transcript item was originally sent. This field
// is populated only when the transcript item is from the current chat session.
ContactId *string `min:"1" type:"string"`
// 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 metadata related to the message. Currently this supports only information
// related to message receipts.
MessageMetadata *MessageMetadata `type:"structure"`
// 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"`
// The contactId on which the transcript item was originally sent. This field
// is only populated for persistent chats when the transcript item is from the
// past chat session. For more information, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html).
RelatedContactId *string `min:"1" type:"string"`
// 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 (s Item) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Item) SetAbsoluteTime(v string) *Item
SetAbsoluteTime sets the AbsoluteTime field's value.
func (s *Item) SetAttachments(v []*AttachmentItem) *Item
SetAttachments sets the Attachments field's value.
func (s *Item) SetContactId(v string) *Item
SetContactId sets the ContactId field's value.
func (s *Item) SetContent(v string) *Item
SetContent sets the Content field's value.
func (s *Item) SetContentType(v string) *Item
SetContentType sets the ContentType field's value.
func (s *Item) SetDisplayName(v string) *Item
SetDisplayName sets the DisplayName field's value.
func (s *Item) SetId(v string) *Item
SetId sets the Id field's value.
func (s *Item) SetMessageMetadata(v *MessageMetadata) *Item
SetMessageMetadata sets the MessageMetadata field's value.
func (s *Item) SetParticipantId(v string) *Item
SetParticipantId sets the ParticipantId field's value.
func (s *Item) SetParticipantRole(v string) *Item
SetParticipantRole sets the ParticipantRole field's value.
func (s *Item) SetRelatedContactId(v string) *Item
SetRelatedContactId sets the RelatedContactId field's value.
func (s *Item) SetType(v string) *Item
SetType sets the Type field's value.
func (s Item) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MessageMetadata struct {
// The identifier of the message that contains the metadata information.
MessageId *string `min:"1" type:"string"`
// The list of receipt information for a message for different recipients.
Receipts []*Receipt `type:"list"`
// contains filtered or unexported fields
}
Contains metadata related to a message.
func (s MessageMetadata) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MessageMetadata) SetMessageId(v string) *MessageMetadata
SetMessageId sets the MessageId field's value.
func (s *MessageMetadata) SetReceipts(v []*Receipt) *MessageMetadata
SetReceipts sets the Receipts field's value.
func (s MessageMetadata) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Receipt struct {
// The time when the message was delivered to the recipient.
DeliveredTimestamp *string `min:"1" type:"string"`
// The time when the message was read by the recipient.
ReadTimestamp *string `min:"1" type:"string"`
// The identifier of the recipient of the message.
RecipientParticipantId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
The receipt for the message delivered to the recipient.
func (s Receipt) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Receipt) SetDeliveredTimestamp(v string) *Receipt
SetDeliveredTimestamp sets the DeliveredTimestamp field's value.
func (s *Receipt) SetReadTimestamp(v string) *Receipt
SetReadTimestamp sets the ReadTimestamp field's value.
func (s *Receipt) SetRecipientParticipantId(v string) *Receipt
SetRecipientParticipantId sets the RecipientParticipantId field's value.
func (s Receipt) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier of the resource.
ResourceId *string `type:"string"`
// The type of Amazon Connect resource.
ResourceType *string `type:"string" enum:"ResourceType"`
// contains filtered or unexported fields
}
The resource was not found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SendEventInput struct {
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. If not provided, the Amazon Web Services SDK populates this
// field. For more information about idempotency, see Making retries safe with
// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
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). For content
// related to message receipts, this is supported in the form of a JSON string.
//
// Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"
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 (will
// be deprecated on December 31, 2024)
//
// * application/vnd.amazonaws.connect.event.message.delivered
//
// * application/vnd.amazonaws.connect.event.message.read
//
// ContentType is a required field
ContentType *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s SendEventInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SendEventInput) SetClientToken(v string) *SendEventInput
SetClientToken sets the ClientToken field's value.
func (s *SendEventInput) SetConnectionToken(v string) *SendEventInput
SetConnectionToken sets the ConnectionToken field's value.
func (s *SendEventInput) SetContent(v string) *SendEventInput
SetContent sets the Content field's value.
func (s *SendEventInput) SetContentType(v string) *SendEventInput
SetContentType sets the ContentType field's value.
func (s SendEventInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SendEventInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s SendEventOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SendEventOutput) SetAbsoluteTime(v string) *SendEventOutput
SetAbsoluteTime sets the AbsoluteTime field's value.
func (s *SendEventOutput) SetId(v string) *SendEventOutput
SetId sets the Id field's value.
func (s SendEventOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SendMessageInput struct {
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. If not provided, the Amazon Web Services SDK populates this
// field. For more information about idempotency, see Making retries safe with
// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
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.
//
// * For text/plain and text/markdown, the Length Constraints are Minimum
// of 1, Maximum of 1024.
//
// * For application/json, the Length Constraints are Minimum of 1, Maximum
// of 12000.
//
// * For application/vnd.amazonaws.connect.message.interactive.response,
// the Length Constraints are Minimum of 1, Maximum of 12288.
//
// Content is a required field
Content *string `min:"1" type:"string" required:"true"`
// The type of the content. Supported types are text/plain, text/markdown, application/json,
// and application/vnd.amazonaws.connect.message.interactive.response.
//
// ContentType is a required field
ContentType *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s SendMessageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SendMessageInput) SetClientToken(v string) *SendMessageInput
SetClientToken sets the ClientToken field's value.
func (s *SendMessageInput) SetConnectionToken(v string) *SendMessageInput
SetConnectionToken sets the ConnectionToken field's value.
func (s *SendMessageInput) SetContent(v string) *SendMessageInput
SetContent sets the Content field's value.
func (s *SendMessageInput) SetContentType(v string) *SendMessageInput
SetContentType sets the ContentType field's value.
func (s SendMessageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SendMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s SendMessageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SendMessageOutput) SetAbsoluteTime(v string) *SendMessageOutput
SetAbsoluteTime sets the AbsoluteTime field's value.
func (s *SendMessageOutput) SetId(v string) *SendMessageOutput
SetId sets the Id field's value.
func (s SendMessageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 that you provide to ensure the idempotency
// of the request. If not provided, the Amazon Web Services SDK populates this
// field. For more information about idempotency, see Making retries safe with
// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
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/feature-limits.html)
// 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 (s StartAttachmentUploadInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartAttachmentUploadInput) SetAttachmentName(v string) *StartAttachmentUploadInput
SetAttachmentName sets the AttachmentName field's value.
func (s *StartAttachmentUploadInput) SetAttachmentSizeInBytes(v int64) *StartAttachmentUploadInput
SetAttachmentSizeInBytes sets the AttachmentSizeInBytes field's value.
func (s *StartAttachmentUploadInput) SetClientToken(v string) *StartAttachmentUploadInput
SetClientToken sets the ClientToken field's value.
func (s *StartAttachmentUploadInput) SetConnectionToken(v string) *StartAttachmentUploadInput
SetConnectionToken sets the ConnectionToken field's value.
func (s *StartAttachmentUploadInput) SetContentType(v string) *StartAttachmentUploadInput
SetContentType sets the ContentType field's value.
func (s StartAttachmentUploadInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartAttachmentUploadInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s StartAttachmentUploadOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartAttachmentUploadOutput) SetAttachmentId(v string) *StartAttachmentUploadOutput
SetAttachmentId sets the AttachmentId field's value.
func (s *StartAttachmentUploadOutput) SetUploadMetadata(v *UploadMetadata) *StartAttachmentUploadOutput
SetUploadMetadata sets the UploadMetadata field's value.
func (s StartAttachmentUploadOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s StartPosition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartPosition) SetAbsoluteTime(v string) *StartPosition
SetAbsoluteTime sets the AbsoluteTime field's value.
func (s *StartPosition) SetId(v string) *StartPosition
SetId sets the Id field's value.
func (s *StartPosition) SetMostRecent(v int64) *StartPosition
SetMostRecent sets the MostRecent field's value.
func (s StartPosition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartPosition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UploadMetadata struct {
// The headers to be provided while uploading the file to the URL.
HeadersToInclude map[string]*string `type:"map"`
// This is the pre-signed URL that can be used for uploading the file to Amazon
// S3 when used in response to StartAttachmentUpload (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html).
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 (s UploadMetadata) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UploadMetadata) SetHeadersToInclude(v map[string]*string) *UploadMetadata
SetHeadersToInclude sets the HeadersToInclude field's value.
func (s *UploadMetadata) SetUrl(v string) *UploadMetadata
SetUrl sets the Url field's value.
func (s *UploadMetadata) SetUrlExpiry(v string) *UploadMetadata
SetUrlExpiry sets the UrlExpiry field's value.
func (s UploadMetadata) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type View struct {
// The Amazon Resource Name (ARN) of the view.
Arn *string `type:"string"`
// View content containing all content necessary to render a view except for
// runtime input data.
Content *ViewContent `type:"structure"`
// The identifier of the view.
Id *string `min:"1" type:"string"`
// The name of the view.
//
// Name is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by View's
// String and GoString methods.
Name *string `min:"1" type:"string" sensitive:"true"`
// The current version of the view.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
A view resource object. Contains metadata and content necessary to render the view.
func (s View) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *View) SetArn(v string) *View
SetArn sets the Arn field's value.
func (s *View) SetContent(v *ViewContent) *View
SetContent sets the Content field's value.
func (s *View) SetId(v string) *View
SetId sets the Id field's value.
func (s *View) SetName(v string) *View
SetName sets the Name field's value.
func (s *View) SetVersion(v int64) *View
SetVersion sets the Version field's value.
func (s View) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ViewContent struct {
// A list of actions possible from the view
Actions []*string `type:"list" sensitive:"true"`
// The schema representing the input data that the view template must be supplied
// to render.
//
// InputSchema is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ViewContent's
// String and GoString methods.
InputSchema *string `type:"string" sensitive:"true"`
// The view template representing the structure of the view.
//
// Template is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ViewContent's
// String and GoString methods.
Template *string `type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
View content containing all content necessary to render a view except for runtime input data.
func (s ViewContent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ViewContent) SetActions(v []*string) *ViewContent
SetActions sets the Actions field's value.
func (s *ViewContent) SetInputSchema(v string) *ViewContent
SetInputSchema sets the InputSchema field's value.
func (s *ViewContent) SetTemplate(v string) *ViewContent
SetTemplate sets the Template field's value.
func (s ViewContent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 (s Websocket) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Websocket) SetConnectionExpiry(v string) *Websocket
SetConnectionExpiry sets the ConnectionExpiry field's value.
func (s *Websocket) SetUrl(v string) *Websocket
SetUrl sets the Url field's value.
func (s Websocket) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".