connect

package
v2.0.0-preview.4+incom... Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

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

The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. 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.

See https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (

	// ErrCodeContactNotFoundException for service response error code
	// "ContactNotFoundException".
	//
	// The contact with the specified ID is not active or does not exist.
	ErrCodeContactNotFoundException = "ContactNotFoundException"

	// ErrCodeDestinationNotAllowedException for service response error code
	// "DestinationNotAllowedException".
	//
	// Outbound calls to the destination number are not allowed for your instance.
	// You can request that the country be included in the allowed countries for
	// your instance by submitting a Service Limit Increase (https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase).
	ErrCodeDestinationNotAllowedException = "DestinationNotAllowedException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// Request processing failed due to an error or failure with the service.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// One or more of the parameters provided to the operation are not valid.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is not valid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The limit exceeded the maximum allowed active calls in a queue.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeOutboundContactNotPermittedException for service response error code
	// "OutboundContactNotPermittedException".
	//
	// The contact is not permitted because outbound calling is not enabled for
	// the instance.
	ErrCodeOutboundContactNotPermittedException = "OutboundContactNotPermittedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "connect"   // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Connect 

type Connect struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Connect

New creates a new instance of the Connect client with a config.

Example: 

// Create a Connect client from just a config.
svc := connect.New(myConfig)

func (*Connect) StartOutboundVoiceContactRequest 

func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceContactInput) StartOutboundVoiceContactRequest

StartOutboundVoiceContactRequest returns a request value for making API operation for Amazon Connect Service.

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

There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.

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

// Example sending a request using the StartOutboundVoiceContactRequest method.
req := client.StartOutboundVoiceContactRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Connect) StopContactRequest 

func (c *Connect) StopContactRequest(input *StopContactInput) StopContactRequest

StopContactRequest returns a request value for making API operation for Amazon Connect Service.

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permissions to the connect:StopContact operation. 

// Example sending a request using the StopContactRequest method.
req := client.StopContactRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

type StartOutboundVoiceContactInput 

type StartOutboundVoiceContactInput struct {

	// Specify a custom key-value pair using an attribute map. The attributes are
	// standard Amazon Connect attributes, and can be accessed in contact flows
	// just like any other contact attributes.
	//
	// There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute
	// keys can include only alphanumeric, dash, and underscore characters.
	//
	// For example, to play a greeting when the customer answers the call, you can
	// pass the customer name in attributes similar to the following:
	Attributes map[string]string `type:"map"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. The token is valid for 7 days after creation. If a contact
	// is already started, the contact ID is returned. If the contact is disconnected,
	// a new contact is started.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The identifier for the contact flow to execute for the outbound call. This
	// is a GUID value only. Amazon Resource Name (ARN) values are not supported.
	//
	// To find the ContactFlowId, open the contact flow to use in the Amazon Connect
	// contact flow designer. The ID for the contact flow is displayed in the address
	// bar as part of the URL. For example, an address displayed when you open a
	// contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181.
	// At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181.
	// The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181.
	// Make sure to include only the GUID after the "contact-flow/" in your requests.
	//
	// ContactFlowId is a required field
	ContactFlowId *string `type:"string" required:"true"`

	// The phone number, in E.164 format, of the customer to call with the outbound
	// contact.
	//
	// DestinationPhoneNumber is a required field
	DestinationPhoneNumber *string `type:"string" required:"true"`

	// The identifier for your Amazon Connect instance. To find the InstanceId value
	// for your Amazon Connect instance, open the Amazon Connect console (https://console.aws.amazon.com/connect/).
	// Select the instance alias of the instance and view the instance ID in the
	// Overview section. For example, the instance ID is the set of characters at
	// the end of the instance ARN, after "instance/", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The queue to which to add the call. If you specify a queue, the phone displayed
	// for caller ID is the phone number defined for the queue. If you do not specify
	// a queue, the queue used is the queue defined in the contact flow specified
	// by ContactFlowId.
	//
	// To find the QueueId, open the queue to use in the Amazon Connect queue editor.
	// The ID for the queue is displayed in the address bar as part of the URL.
	// For example, the QueueId value is the set of characters at the end of the
	// URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c.
	QueueId *string `type:"string"`

	// The phone number, in E.164 format, associated with your Amazon Connect instance
	// to use to place the outbound call.
	SourcePhoneNumber *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest

func (StartOutboundVoiceContactInput) GoString 

func (s StartOutboundVoiceContactInput) GoString() string

GoString returns the string representation

func (StartOutboundVoiceContactInput) MarshalFields 

func (s StartOutboundVoiceContactInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartOutboundVoiceContactInput) String 

func (s StartOutboundVoiceContactInput) String() string

String returns the string representation

func (*StartOutboundVoiceContactInput) Validate 

func (s *StartOutboundVoiceContactInput) Validate() error

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

type StartOutboundVoiceContactOutput 

type StartOutboundVoiceContactOutput struct {

	// The unique identifier of this contact within your Amazon Connect instance.
	ContactId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactResponse

func (StartOutboundVoiceContactOutput) GoString 

func (s StartOutboundVoiceContactOutput) GoString() string

GoString returns the string representation

func (StartOutboundVoiceContactOutput) MarshalFields 

func (s StartOutboundVoiceContactOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartOutboundVoiceContactOutput) SDKResponseMetadata 

func (s StartOutboundVoiceContactOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StartOutboundVoiceContactOutput) String 

func (s StartOutboundVoiceContactOutput) String() string

String returns the string representation

type StartOutboundVoiceContactRequest 

type StartOutboundVoiceContactRequest struct {
	*aws.Request
	Input *StartOutboundVoiceContactInput
	Copy  func(*StartOutboundVoiceContactInput) StartOutboundVoiceContactRequest
}

StartOutboundVoiceContactRequest is a API request type for the StartOutboundVoiceContact API operation.

func (StartOutboundVoiceContactRequest) Send 

func (r StartOutboundVoiceContactRequest) Send() (*StartOutboundVoiceContactOutput, error)

Send marshals and sends the StartOutboundVoiceContact API request.

type StopContactInput 

type StopContactInput struct {

	// The unique identifier of the contact to end. This is the ContactId value
	// returned from the StartOutboundVoiceContact operation.
	//
	// ContactId is a required field
	ContactId *string `min:"1" type:"string" required:"true"`

	// The identifier of the Amazon Connect instance in which the contact is active.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest

func (StopContactInput) GoString 

func (s StopContactInput) GoString() string

GoString returns the string representation

func (StopContactInput) MarshalFields 

func (s StopContactInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopContactInput) String 

func (s StopContactInput) String() string

String returns the string representation

func (*StopContactInput) Validate 

func (s *StopContactInput) Validate() error

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

type StopContactOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactResponse

func (StopContactOutput) GoString 

func (s StopContactOutput) GoString() string

GoString returns the string representation

func (StopContactOutput) MarshalFields 

func (s StopContactOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopContactOutput) SDKResponseMetadata 

func (s StopContactOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StopContactOutput) String 

func (s StopContactOutput) String() string

String returns the string representation

type StopContactRequest 

type StopContactRequest struct {
	*aws.Request
	Input *StopContactInput
	Copy  func(*StopContactInput) StopContactRequest
}

StopContactRequest is a API request type for the StopContact API operation.

func (StopContactRequest) Send 

func (r StopContactRequest) Send() (*StopContactOutput, error)

Send marshals and sends the StopContact API request.

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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