aws-sdk-go: github.com/aws/aws-sdk-go/service/connectparticipant Index | Files | Directories

package connectparticipant

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

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

Package Files

api.go doc.go errors.go service.go

Constants

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

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

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

    // ConnectionTypeConnectionCredentials is a ConnectionType enum value
    ConnectionTypeConnectionCredentials = "CONNECTION_CREDENTIALS"
)
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"
)
const (
    // ScanDirectionForward is a ScanDirection enum value
    ScanDirectionForward = "FORWARD"

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

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

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

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

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

type AccessDeniedException Uses

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 Uses

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error Uses

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString Uses

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message Uses

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr Uses

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID Uses

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode Uses

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String Uses

func (s AccessDeniedException) String() string

String returns the string representation

type ConnectParticipant Uses

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 Uses

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) CreateParticipantConnection Uses

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 the 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.

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 Uses

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 Uses

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 Uses

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.

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 Uses

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 Uses

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) GetTranscript Uses

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

GetTranscript API operation for Amazon Connect Participant Service.

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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.

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 Uses

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 Uses

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 Uses

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.

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 Uses

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 Uses

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.

type ConnectionCredentials Uses

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 Uses

func (s ConnectionCredentials) GoString() string

GoString returns the string representation

func (*ConnectionCredentials) SetConnectionToken Uses

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

SetConnectionToken sets the ConnectionToken field's value.

func (*ConnectionCredentials) SetExpiry Uses

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

SetExpiry sets the Expiry field's value.

func (ConnectionCredentials) String Uses

func (s ConnectionCredentials) String() string

String returns the string representation

type CreateParticipantConnectionInput Uses

type CreateParticipantConnectionInput struct {

    // Participant Token as obtained from StartChatContact (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContactResponse.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 Uses

func (s CreateParticipantConnectionInput) GoString() string

GoString returns the string representation

func (*CreateParticipantConnectionInput) SetParticipantToken Uses

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

SetParticipantToken sets the ParticipantToken field's value.

func (*CreateParticipantConnectionInput) SetType Uses

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

SetType sets the Type field's value.

func (CreateParticipantConnectionInput) String Uses

func (s CreateParticipantConnectionInput) String() string

String returns the string representation

func (*CreateParticipantConnectionInput) Validate Uses

func (s *CreateParticipantConnectionInput) Validate() error

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

type CreateParticipantConnectionOutput Uses

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 Uses

func (s CreateParticipantConnectionOutput) GoString() string

GoString returns the string representation

func (*CreateParticipantConnectionOutput) SetConnectionCredentials Uses

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

SetConnectionCredentials sets the ConnectionCredentials field's value.

func (*CreateParticipantConnectionOutput) SetWebsocket Uses

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

SetWebsocket sets the Websocket field's value.

func (CreateParticipantConnectionOutput) String Uses

func (s CreateParticipantConnectionOutput) String() string

String returns the string representation

type DisconnectParticipantInput Uses

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 Uses

func (s DisconnectParticipantInput) GoString() string

GoString returns the string representation

func (*DisconnectParticipantInput) SetClientToken Uses

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

SetClientToken sets the ClientToken field's value.

func (*DisconnectParticipantInput) SetConnectionToken Uses

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

SetConnectionToken sets the ConnectionToken field's value.

func (DisconnectParticipantInput) String Uses

func (s DisconnectParticipantInput) String() string

String returns the string representation

func (*DisconnectParticipantInput) Validate Uses

func (s *DisconnectParticipantInput) Validate() error

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

type DisconnectParticipantOutput Uses

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

func (DisconnectParticipantOutput) GoString Uses

func (s DisconnectParticipantOutput) GoString() string

GoString returns the string representation

func (DisconnectParticipantOutput) String Uses

func (s DisconnectParticipantOutput) String() string

String returns the string representation

type GetTranscriptInput Uses

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 Uses

func (s GetTranscriptInput) GoString() string

GoString returns the string representation

func (*GetTranscriptInput) SetConnectionToken Uses

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

SetConnectionToken sets the ConnectionToken field's value.

func (*GetTranscriptInput) SetContactId Uses

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

SetContactId sets the ContactId field's value.

func (*GetTranscriptInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetTranscriptInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetTranscriptInput) SetScanDirection Uses

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

SetScanDirection sets the ScanDirection field's value.

func (*GetTranscriptInput) SetSortOrder Uses

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

SetSortOrder sets the SortOrder field's value.

func (*GetTranscriptInput) SetStartPosition Uses

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

SetStartPosition sets the StartPosition field's value.

func (GetTranscriptInput) String Uses

func (s GetTranscriptInput) String() string

String returns the string representation

func (*GetTranscriptInput) Validate Uses

func (s *GetTranscriptInput) Validate() error

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

type GetTranscriptOutput Uses

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 Uses

func (s GetTranscriptOutput) GoString() string

GoString returns the string representation

func (*GetTranscriptOutput) SetInitialContactId Uses

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

SetInitialContactId sets the InitialContactId field's value.

func (*GetTranscriptOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetTranscriptOutput) SetTranscript Uses

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

SetTranscript sets the Transcript field's value.

func (GetTranscriptOutput) String Uses

func (s GetTranscriptOutput) String() string

String returns the string representation

type InternalServerException Uses

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 Uses

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error Uses

func (s *InternalServerException) Error() string

func (InternalServerException) GoString Uses

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message Uses

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr Uses

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID Uses

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode Uses

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String Uses

func (s InternalServerException) String() string

String returns the string representation

type Item Uses

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

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

func (s Item) GoString() string

GoString returns the string representation

func (*Item) SetAbsoluteTime Uses

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

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*Item) SetContent Uses

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

SetContent sets the Content field's value.

func (*Item) SetContentType Uses

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

SetContentType sets the ContentType field's value.

func (*Item) SetDisplayName Uses

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

SetDisplayName sets the DisplayName field's value.

func (*Item) SetId Uses

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

SetId sets the Id field's value.

func (*Item) SetParticipantId Uses

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

SetParticipantId sets the ParticipantId field's value.

func (*Item) SetParticipantRole Uses

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

SetParticipantRole sets the ParticipantRole field's value.

func (*Item) SetType Uses

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

SetType sets the Type field's value.

func (Item) String Uses

func (s Item) String() string

String returns the string representation

type SendEventInput Uses

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 Uses

func (s SendEventInput) GoString() string

GoString returns the string representation

func (*SendEventInput) SetClientToken Uses

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

SetClientToken sets the ClientToken field's value.

func (*SendEventInput) SetConnectionToken Uses

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

SetConnectionToken sets the ConnectionToken field's value.

func (*SendEventInput) SetContent Uses

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

SetContent sets the Content field's value.

func (*SendEventInput) SetContentType Uses

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

SetContentType sets the ContentType field's value.

func (SendEventInput) String Uses

func (s SendEventInput) String() string

String returns the string representation

func (*SendEventInput) Validate Uses

func (s *SendEventInput) Validate() error

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

type SendEventOutput Uses

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 Uses

func (s SendEventOutput) GoString() string

GoString returns the string representation

func (*SendEventOutput) SetAbsoluteTime Uses

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

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*SendEventOutput) SetId Uses

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

SetId sets the Id field's value.

func (SendEventOutput) String Uses

func (s SendEventOutput) String() string

String returns the string representation

type SendMessageInput Uses

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 Uses

func (s SendMessageInput) GoString() string

GoString returns the string representation

func (*SendMessageInput) SetClientToken Uses

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

SetClientToken sets the ClientToken field's value.

func (*SendMessageInput) SetConnectionToken Uses

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

SetConnectionToken sets the ConnectionToken field's value.

func (*SendMessageInput) SetContent Uses

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

SetContent sets the Content field's value.

func (*SendMessageInput) SetContentType Uses

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

SetContentType sets the ContentType field's value.

func (SendMessageInput) String Uses

func (s SendMessageInput) String() string

String returns the string representation

func (*SendMessageInput) Validate Uses

func (s *SendMessageInput) Validate() error

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

type SendMessageOutput Uses

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 Uses

func (s SendMessageOutput) GoString() string

GoString returns the string representation

func (*SendMessageOutput) SetAbsoluteTime Uses

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

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*SendMessageOutput) SetId Uses

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

SetId sets the Id field's value.

func (SendMessageOutput) String Uses

func (s SendMessageOutput) String() string

String returns the string representation

type StartPosition Uses

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 Uses

func (s StartPosition) GoString() string

GoString returns the string representation

func (*StartPosition) SetAbsoluteTime Uses

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

SetAbsoluteTime sets the AbsoluteTime field's value.

func (*StartPosition) SetId Uses

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

SetId sets the Id field's value.

func (*StartPosition) SetMostRecent Uses

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

SetMostRecent sets the MostRecent field's value.

func (StartPosition) String Uses

func (s StartPosition) String() string

String returns the string representation

func (*StartPosition) Validate Uses

func (s *StartPosition) Validate() error

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

type ThrottlingException Uses

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 Uses

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error Uses

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString Uses

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message Uses

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr Uses

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID Uses

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode Uses

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String Uses

func (s ThrottlingException) String() string

String returns the string representation

type ValidationException Uses

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 Uses

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error Uses

func (s *ValidationException) Error() string

func (ValidationException) GoString Uses

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message Uses

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr Uses

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID Uses

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode Uses

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String Uses

func (s ValidationException) String() string

String returns the string representation

type Websocket Uses

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 Uses

func (s Websocket) GoString() string

GoString returns the string representation

func (*Websocket) SetConnectionExpiry Uses

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

SetConnectionExpiry sets the ConnectionExpiry field's value.

func (*Websocket) SetUrl Uses

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

SetUrl sets the Url field's value.

func (Websocket) String Uses

func (s Websocket) String() string

String returns the string representation

Directories

PathSynopsis
connectparticipantifacePackage connectparticipantiface provides an interface to enable mocking the Amazon Connect Participant Service service client for testing your code.

Package connectparticipant imports 9 packages (graph) and is imported by 6 packages. Updated 2020-03-31. Refresh now. Tools for package owners.