connectcases

package module
v1.21.8 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 47 Imported by: 6

Documentation

Overview

Package connectcases provides the API client, operations, and parameter types for Amazon Connect Cases.

With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Casesin the Amazon Connect Administrator Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2022-10-03"
View Source 
const ServiceID = "ConnectCases"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.6.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.11.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.11.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.11.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.11.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetFieldInput 

type BatchGetFieldInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// A list of unique field identifiers.
	//
	// This member is required.
	Fields []types.FieldIdentifier
	// contains filtered or unexported fields
}

type BatchGetFieldOutput 

type BatchGetFieldOutput struct {

	// A list of field errors.
	//
	// This member is required.
	Errors []types.FieldError

	// A list of detailed field information.
	//
	// This member is required.
	Fields []types.GetFieldResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchPutFieldOptionsInput 

type BatchPutFieldOptionsInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The unique identifier of a field.
	//
	// This member is required.
	FieldId *string

	// A list of FieldOption objects.
	//
	// This member is required.
	Options []types.FieldOption
	// contains filtered or unexported fields
}

type BatchPutFieldOptionsOutput 

type BatchPutFieldOptionsOutput struct {

	// A list of field errors.
	Errors []types.FieldOptionError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

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

Client provides the API client to make operations call for Amazon Connect Cases.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetField 

func (c *Client) BatchGetField(ctx context.Context, params *BatchGetFieldInput, optFns ...func(*Options)) (*BatchGetFieldOutput, error)

Returns the description for the list of fields in the request parameters.

func (*Client) BatchPutFieldOptions 

func (c *Client) BatchPutFieldOptions(ctx context.Context, params *BatchPutFieldOptionsInput, optFns ...func(*Options)) (*BatchPutFieldOptionsOutput, error)

Creates and updates a set of field options for a single select field in a Cases domain.

func (*Client) CreateCase 

func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error)

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

The following fields are required when creating a case:

  • customer_id - You must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID

  • title

func (*Client) CreateDomain 

func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error)

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociationAPI. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

func (*Client) CreateField 

func (c *Client) CreateField(ctx context.Context, params *CreateFieldInput, optFns ...func(*Options)) (*CreateFieldOutput, error)

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

func (*Client) CreateLayout 

func (c *Client) CreateLayout(ctx context.Context, params *CreateLayoutInput, optFns ...func(*Options)) (*CreateLayoutOutput, error)

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

  • Fields to display to the users

  • Field ordering

Title and Status fields cannot be part of layouts since they are not configurable.

func (*Client) CreateRelatedItem 

func (c *Client) CreateRelatedItem(ctx context.Context, params *CreateRelatedItemInput, optFns ...func(*Options)) (*CreateRelatedItemOutput, error)

Creates a related item (comments, tasks, and contacts) and associates it with a case.

  • A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn ). All Related Items have their own internal identifier, the relatedItemArn . Examples of related items include comments and contacts .

  • If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.

func (*Client) CreateTemplate 

func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

func (*Client) DeleteDomain added in v1.3.0 

func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error)

Deletes a Cases domain.

After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation.

func (*Client) DeleteField added in v1.16.0 

func (c *Client) DeleteField(ctx context.Context, params *DeleteFieldInput, optFns ...func(*Options)) (*DeleteFieldOutput, error)

Deletes a field from a cases template. You can delete up to 100 fields per domain.

After a field is deleted:

  • You can still retrieve the field by calling BatchGetField .

  • You cannot update a deleted field by calling UpdateField ; it throws a ValidationException .

  • Deleted fields are not included in the ListFields response.

  • Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.

  • Calling GetCase with a deleted field ID returns the deleted field's value if one exists.

  • Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {} ) the field's value from the case.

  • GetTemplate does not return field IDs for deleted fields.

  • GetLayout does not return field IDs for deleted fields.

  • Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.

  • Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.

  • Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException .

  • Calling GetCaseEventConfiguration does not return field IDs for deleted fields.

func (*Client) DeleteLayout added in v1.16.0 

func (c *Client) DeleteLayout(ctx context.Context, params *DeleteLayoutInput, optFns ...func(*Options)) (*DeleteLayoutOutput, error)

Deletes a layout from a cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:

  • You can still retrieve the layout by calling GetLayout .

  • You cannot update a deleted layout by calling UpdateLayout ; it throws a ValidationException .

  • Deleted layouts are not included in the ListLayouts response.

func (*Client) DeleteTemplate added in v1.16.0 

func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)

Deletes a cases template. You can delete up to 100 templates per domain.

After a cases template is deleted:

  • You can still retrieve the template by calling GetTemplate .

  • You cannot update the template.

  • You cannot create a case by using the deleted template.

  • Deleted templates are not included in the ListTemplates response.

func (*Client) GetCase 

func (c *Client) GetCase(ctx context.Context, params *GetCaseInput, optFns ...func(*Options)) (*GetCaseOutput, error)

Returns information about a specific case if it exists.

func (*Client) GetCaseAuditEvents added in v1.13.0 

func (c *Client) GetCaseAuditEvents(ctx context.Context, params *GetCaseAuditEventsInput, optFns ...func(*Options)) (*GetCaseAuditEventsOutput, error)

Returns the audit history about a specific case if it exists.

func (*Client) GetCaseEventConfiguration 

func (c *Client) GetCaseEventConfiguration(ctx context.Context, params *GetCaseEventConfigurationInput, optFns ...func(*Options)) (*GetCaseEventConfigurationOutput, error)

Returns the case event publishing configuration.

func (*Client) GetDomain 

func (c *Client) GetDomain(ctx context.Context, params *GetDomainInput, optFns ...func(*Options)) (*GetDomainOutput, error)

Returns information about a specific domain if it exists.

func (*Client) GetLayout 

func (c *Client) GetLayout(ctx context.Context, params *GetLayoutInput, optFns ...func(*Options)) (*GetLayoutOutput, error)

Returns the details for the requested layout.

func (*Client) GetTemplate 

func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error)

Returns the details for the requested template.

func (*Client) ListCasesForContact 

func (c *Client) ListCasesForContact(ctx context.Context, params *ListCasesForContactInput, optFns ...func(*Options)) (*ListCasesForContactOutput, error)

Lists cases for a given contact.

func (*Client) ListDomains 

func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error)

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

func (*Client) ListFieldOptions 

func (c *Client) ListFieldOptions(ctx context.Context, params *ListFieldOptionsInput, optFns ...func(*Options)) (*ListFieldOptionsOutput, error)

Lists all of the field options for a field identifier in the domain.

func (*Client) ListFields 

func (c *Client) ListFields(ctx context.Context, params *ListFieldsInput, optFns ...func(*Options)) (*ListFieldsOutput, error)

Lists all fields in a Cases domain.

func (*Client) ListLayouts 

func (c *Client) ListLayouts(ctx context.Context, params *ListLayoutsInput, optFns ...func(*Options)) (*ListLayoutsOutput, error)

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists tags for a resource.

func (*Client) ListTemplates 

func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error)

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

func (*Client) Options added in v1.12.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutCaseEventConfiguration 

func (c *Client) PutCaseEventConfiguration(ctx context.Context, params *PutCaseEventConfigurationInput, optFns ...func(*Options)) (*PutCaseEventConfigurationOutput, error)

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fieldsin the Amazon Connect Administrator Guide

func (*Client) SearchCases 

func (c *Client) SearchCases(ctx context.Context, params *SearchCasesInput, optFns ...func(*Options)) (*SearchCasesOutput, error)

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID .

func (*Client) SearchRelatedItems 

func (c *Client) SearchRelatedItems(ctx context.Context, params *SearchRelatedItemsInput, optFns ...func(*Options)) (*SearchRelatedItemsOutput, error)

Searches for related items that are associated with a case.

If no filters are provided, this returns all related items associated with a case.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to a resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Untags a resource.

func (*Client) UpdateCase 

func (c *Client) UpdateCase(ctx context.Context, params *UpdateCaseInput, optFns ...func(*Options)) (*UpdateCaseOutput, error)

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

func (*Client) UpdateField 

func (c *Client) UpdateField(ctx context.Context, params *UpdateFieldInput, optFns ...func(*Options)) (*UpdateFieldOutput, error)

Updates the properties of an existing field.

func (*Client) UpdateLayout 

func (c *Client) UpdateLayout(ctx context.Context, params *UpdateLayoutInput, optFns ...func(*Options)) (*UpdateLayoutOutput, error)

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A ValidationException is returned when you add non-existent fieldIds to a layout.

Title and Status fields cannot be part of layouts because they are not configurable.

func (*Client) UpdateTemplate 

func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)

Updates the attributes of an existing template. The template attributes that can be modified include name , description , layoutConfiguration , requiredFields , and status . At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

type CreateCaseInput 

type CreateCaseInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// An array of objects with field ID (matching ListFields/DescribeField) and value
	// union data.
	//
	// This member is required.
	Fields []types.FieldValue

	// A unique identifier of a template.
	//
	// This member is required.
	TemplateId *string

	// 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].
	//
	// [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// Represents the identity of the person who performed the action.
	PerformedBy types.UserUnion
	// contains filtered or unexported fields
}

type CreateCaseOutput 

type CreateCaseOutput struct {

	// The Amazon Resource Name (ARN) of the case.
	//
	// This member is required.
	CaseArn *string

	// A unique identifier of the case.
	//
	// This member is required.
	CaseId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDomainInput 

type CreateDomainInput struct {

	// The name for your Cases domain. It must be unique for your Amazon Web Services
	// account.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type CreateDomainOutput 

type CreateDomainOutput struct {

	// The Amazon Resource Name (ARN) for the Cases domain.
	//
	// This member is required.
	DomainArn *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The status of the domain.
	//
	// This member is required.
	DomainStatus types.DomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFieldInput 

type CreateFieldInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The name of the field.
	//
	// This member is required.
	Name *string

	// Defines the data type, some system constraints, and default display of the
	// field.
	//
	// This member is required.
	Type types.FieldType

	// The description of the field.
	Description *string
	// contains filtered or unexported fields
}

type CreateFieldOutput 

type CreateFieldOutput struct {

	// The Amazon Resource Name (ARN) of the field.
	//
	// This member is required.
	FieldArn *string

	// The unique identifier of a field.
	//
	// This member is required.
	FieldId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLayoutInput 

type CreateLayoutInput struct {

	// Information about which fields will be present in the layout, and information
	// about the order of the fields.
	//
	// This member is required.
	Content types.LayoutContent

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The name of the layout. It must be unique for the Cases domain.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type CreateLayoutOutput 

type CreateLayoutOutput struct {

	// The Amazon Resource Name (ARN) of the newly created layout.
	//
	// This member is required.
	LayoutArn *string

	// The unique identifier of the layout.
	//
	// This member is required.
	LayoutId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRelatedItemInput 

type CreateRelatedItemInput struct {

	// A unique identifier of the case.
	//
	// This member is required.
	CaseId *string

	// The content of a related item to be created.
	//
	// This member is required.
	Content types.RelatedItemInputContent

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The type of a related item.
	//
	// This member is required.
	Type types.RelatedItemType

	// Represents the creator of the related item.
	PerformedBy types.UserUnion
	// contains filtered or unexported fields
}

type CreateRelatedItemOutput 

type CreateRelatedItemOutput struct {

	// The Amazon Resource Name (ARN) of the related item.
	//
	// This member is required.
	RelatedItemArn *string

	// The unique identifier of the related item.
	//
	// This member is required.
	RelatedItemId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTemplateInput 

type CreateTemplateInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// A name for the template. It must be unique per domain.
	//
	// This member is required.
	Name *string

	// A brief description of the template.
	Description *string

	// Configuration of layouts associated to the template.
	LayoutConfiguration *types.LayoutConfiguration

	// A list of fields that must contain a value for a case to be successfully
	// created with this template.
	RequiredFields []types.RequiredField

	// The status of the template.
	Status types.TemplateStatus
	// contains filtered or unexported fields
}

type CreateTemplateOutput 

type CreateTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the newly created template.
	//
	// This member is required.
	TemplateArn *string

	// A unique identifier of a template.
	//
	// This member is required.
	TemplateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDomainInput added in v1.3.0 

type DeleteDomainInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string
	// contains filtered or unexported fields
}

type DeleteDomainOutput added in v1.3.0 

type DeleteDomainOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFieldInput added in v1.16.0 

type DeleteFieldInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// Unique identifier of the field.
	//
	// This member is required.
	FieldId *string
	// contains filtered or unexported fields
}

type DeleteFieldOutput added in v1.16.0 

type DeleteFieldOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLayoutInput added in v1.16.0 

type DeleteLayoutInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The unique identifier of the layout.
	//
	// This member is required.
	LayoutId *string
	// contains filtered or unexported fields
}

type DeleteLayoutOutput added in v1.16.0 

type DeleteLayoutOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTemplateInput added in v1.16.0 

type DeleteTemplateInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// A unique identifier of a template.
	//
	// This member is required.
	TemplateId *string
	// contains filtered or unexported fields
}

type DeleteTemplateOutput added in v1.16.0 

type DeleteTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.6.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.6.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.6.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.6.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.6.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCaseAPIClient 

type GetCaseAPIClient interface {
	GetCase(context.Context, *GetCaseInput, ...func(*Options)) (*GetCaseOutput, error)
}

GetCaseAPIClient is a client that implements the GetCase operation.

type GetCaseAuditEventsAPIClient added in v1.13.0 

type GetCaseAuditEventsAPIClient interface {
	GetCaseAuditEvents(context.Context, *GetCaseAuditEventsInput, ...func(*Options)) (*GetCaseAuditEventsOutput, error)
}

GetCaseAuditEventsAPIClient is a client that implements the GetCaseAuditEvents operation.

type GetCaseAuditEventsInput added in v1.13.0 

type GetCaseAuditEventsInput struct {

	// A unique identifier of the case.
	//
	// This member is required.
	CaseId *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The maximum number of audit events to return. The current maximum supported
	// value is 25. This is also the default when no other value is provided.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetCaseAuditEventsOutput added in v1.13.0 

type GetCaseAuditEventsOutput struct {

	// A list of case audits where each represents a particular edit of the case.
	//
	// This member is required.
	AuditEvents []*types.AuditEvent

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCaseAuditEventsPaginator added in v1.13.0 

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

GetCaseAuditEventsPaginator is a paginator for GetCaseAuditEvents

func NewGetCaseAuditEventsPaginator added in v1.13.0 

func NewGetCaseAuditEventsPaginator(client GetCaseAuditEventsAPIClient, params *GetCaseAuditEventsInput, optFns ...func(*GetCaseAuditEventsPaginatorOptions)) *GetCaseAuditEventsPaginator

NewGetCaseAuditEventsPaginator returns a new GetCaseAuditEventsPaginator

func (*GetCaseAuditEventsPaginator) HasMorePages added in v1.13.0 

func (p *GetCaseAuditEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCaseAuditEventsPaginator) NextPage added in v1.13.0 

func (p *GetCaseAuditEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetCaseAuditEventsOutput, error)

NextPage retrieves the next GetCaseAuditEvents page.

type GetCaseAuditEventsPaginatorOptions added in v1.13.0 

type GetCaseAuditEventsPaginatorOptions struct {
	// The maximum number of audit events to return. The current maximum supported
	// value is 25. This is also the default when no other value is provided.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetCaseAuditEventsPaginatorOptions is the paginator options for GetCaseAuditEvents

type GetCaseEventConfigurationInput 

type GetCaseEventConfigurationInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string
	// contains filtered or unexported fields
}

type GetCaseEventConfigurationOutput 

type GetCaseEventConfigurationOutput struct {

	// Configuration to enable EventBridge case event delivery and determine what data
	// is delivered.
	//
	// This member is required.
	EventBridge *types.EventBridgeConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCaseInput 

type GetCaseInput struct {

	// A unique identifier of the case.
	//
	// This member is required.
	CaseId *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// A list of unique field identifiers.
	//
	// This member is required.
	Fields []types.FieldIdentifier

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetCaseOutput 

type GetCaseOutput struct {

	// A list of detailed field information.
	//
	// This member is required.
	Fields []types.FieldValue

	// A unique identifier of a template.
	//
	// This member is required.
	TemplateId *string

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// A map of of key-value pairs that represent tags on a resource. Tags are used to
	// organize, track, or control access for this resource.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCasePaginator 

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

GetCasePaginator is a paginator for GetCase

func NewGetCasePaginator 

func NewGetCasePaginator(client GetCaseAPIClient, params *GetCaseInput, optFns ...func(*GetCasePaginatorOptions)) *GetCasePaginator

NewGetCasePaginator returns a new GetCasePaginator

func (*GetCasePaginator) HasMorePages 

func (p *GetCasePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCasePaginator) NextPage 

func (p *GetCasePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetCaseOutput, error)

NextPage retrieves the next GetCase page.

type GetCasePaginatorOptions 

type GetCasePaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetCasePaginatorOptions is the paginator options for GetCase

type GetDomainInput 

type GetDomainInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string
	// contains filtered or unexported fields
}

type GetDomainOutput 

type GetDomainOutput struct {

	// The timestamp when the Cases domain was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) for the Cases domain.
	//
	// This member is required.
	DomainArn *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The status of the Cases domain.
	//
	// This member is required.
	DomainStatus types.DomainStatus

	// The name of the Cases domain.
	//
	// This member is required.
	Name *string

	// A map of of key-value pairs that represent tags on a resource. Tags are used to
	// organize, track, or control access for this resource.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLayoutInput 

type GetLayoutInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The unique identifier of the layout.
	//
	// This member is required.
	LayoutId *string
	// contains filtered or unexported fields
}

type GetLayoutOutput 

type GetLayoutOutput struct {

	// Information about which fields will be present in the layout, the order of the
	// fields, and read-only attribute of the field.
	//
	// This member is required.
	Content types.LayoutContent

	// The Amazon Resource Name (ARN) of the newly created layout.
	//
	// This member is required.
	LayoutArn *string

	// The unique identifier of the layout.
	//
	// This member is required.
	LayoutId *string

	// The name of the layout. It must be unique.
	//
	// This member is required.
	Name *string

	// Timestamp at which the resource was created.
	CreatedTime *time.Time

	// Denotes whether or not the resource has been deleted.
	Deleted bool

	// Timestamp at which the resource was created or last modified.
	LastModifiedTime *time.Time

	// A map of of key-value pairs that represent tags on a resource. Tags are used to
	// organize, track, or control access for this resource.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTemplateInput 

type GetTemplateInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// A unique identifier of a template.
	//
	// This member is required.
	TemplateId *string
	// contains filtered or unexported fields
}

type GetTemplateOutput 

type GetTemplateOutput struct {

	// The name of the template.
	//
	// This member is required.
	Name *string

	// The status of the template.
	//
	// This member is required.
	Status types.TemplateStatus

	// The Amazon Resource Name (ARN) of the template.
	//
	// This member is required.
	TemplateArn *string

	// A unique identifier of a template.
	//
	// This member is required.
	TemplateId *string

	// Timestamp at which the resource was created.
	CreatedTime *time.Time

	// Denotes whether or not the resource has been deleted.
	Deleted bool

	// A brief description of the template.
	Description *string

	// Timestamp at which the resource was created or last modified.
	LastModifiedTime *time.Time

	// Configuration of layouts associated to the template.
	LayoutConfiguration *types.LayoutConfiguration

	// A list of fields that must contain a value for a case to be successfully
	// created with this template.
	RequiredFields []types.RequiredField

	// A map of of key-value pairs that represent tags on a resource. Tags are used to
	// organize, track, or control access for this resource.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListCasesForContactAPIClient 

type ListCasesForContactAPIClient interface {
	ListCasesForContact(context.Context, *ListCasesForContactInput, ...func(*Options)) (*ListCasesForContactOutput, error)
}

ListCasesForContactAPIClient is a client that implements the ListCasesForContact operation.

type ListCasesForContactInput 

type ListCasesForContactInput struct {

	// A unique identifier of a contact in Amazon Connect.
	//
	// This member is required.
	ContactArn *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCasesForContactOutput 

type ListCasesForContactOutput struct {

	// A list of Case summary information.
	//
	// This member is required.
	Cases []types.CaseSummary

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCasesForContactPaginator 

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

ListCasesForContactPaginator is a paginator for ListCasesForContact

func NewListCasesForContactPaginator 

func NewListCasesForContactPaginator(client ListCasesForContactAPIClient, params *ListCasesForContactInput, optFns ...func(*ListCasesForContactPaginatorOptions)) *ListCasesForContactPaginator

NewListCasesForContactPaginator returns a new ListCasesForContactPaginator

func (*ListCasesForContactPaginator) HasMorePages 

func (p *ListCasesForContactPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCasesForContactPaginator) NextPage 

func (p *ListCasesForContactPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCasesForContactOutput, error)

NextPage retrieves the next ListCasesForContact page.

type ListCasesForContactPaginatorOptions 

type ListCasesForContactPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCasesForContactPaginatorOptions is the paginator options for ListCasesForContact

type ListDomainsAPIClient 

type ListDomainsAPIClient interface {
	ListDomains(context.Context, *ListDomainsInput, ...func(*Options)) (*ListDomainsOutput, error)
}

ListDomainsAPIClient is a client that implements the ListDomains operation.

type ListDomainsInput 

type ListDomainsInput struct {

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDomainsOutput 

type ListDomainsOutput struct {

	// The Cases domain.
	//
	// This member is required.
	Domains []types.DomainSummary

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDomainsPaginator 

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

ListDomainsPaginator is a paginator for ListDomains

func NewListDomainsPaginator 

func NewListDomainsPaginator(client ListDomainsAPIClient, params *ListDomainsInput, optFns ...func(*ListDomainsPaginatorOptions)) *ListDomainsPaginator

NewListDomainsPaginator returns a new ListDomainsPaginator

func (*ListDomainsPaginator) HasMorePages 

func (p *ListDomainsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainsPaginator) NextPage 

func (p *ListDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainsOutput, error)

NextPage retrieves the next ListDomains page.

type ListDomainsPaginatorOptions 

type ListDomainsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDomainsPaginatorOptions is the paginator options for ListDomains

type ListFieldOptionsAPIClient 

type ListFieldOptionsAPIClient interface {
	ListFieldOptions(context.Context, *ListFieldOptionsInput, ...func(*Options)) (*ListFieldOptionsOutput, error)
}

ListFieldOptionsAPIClient is a client that implements the ListFieldOptions operation.

type ListFieldOptionsInput 

type ListFieldOptionsInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The unique identifier of a field.
	//
	// This member is required.
	FieldId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// A list of FieldOption values to filter on for ListFieldOptions .
	Values []string
	// contains filtered or unexported fields
}

type ListFieldOptionsOutput 

type ListFieldOptionsOutput struct {

	// A list of FieldOption objects.
	//
	// This member is required.
	Options []types.FieldOption

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFieldOptionsPaginator 

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

ListFieldOptionsPaginator is a paginator for ListFieldOptions

func NewListFieldOptionsPaginator 

func NewListFieldOptionsPaginator(client ListFieldOptionsAPIClient, params *ListFieldOptionsInput, optFns ...func(*ListFieldOptionsPaginatorOptions)) *ListFieldOptionsPaginator

NewListFieldOptionsPaginator returns a new ListFieldOptionsPaginator

func (*ListFieldOptionsPaginator) HasMorePages 

func (p *ListFieldOptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFieldOptionsPaginator) NextPage 

func (p *ListFieldOptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFieldOptionsOutput, error)

NextPage retrieves the next ListFieldOptions page.

type ListFieldOptionsPaginatorOptions 

type ListFieldOptionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFieldOptionsPaginatorOptions is the paginator options for ListFieldOptions

type ListFieldsAPIClient 

type ListFieldsAPIClient interface {
	ListFields(context.Context, *ListFieldsInput, ...func(*Options)) (*ListFieldsOutput, error)
}

ListFieldsAPIClient is a client that implements the ListFields operation.

type ListFieldsInput 

type ListFieldsInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFieldsOutput 

type ListFieldsOutput struct {

	// List of detailed field information.
	//
	// This member is required.
	Fields []types.FieldSummary

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFieldsPaginator 

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

ListFieldsPaginator is a paginator for ListFields

func NewListFieldsPaginator 

func NewListFieldsPaginator(client ListFieldsAPIClient, params *ListFieldsInput, optFns ...func(*ListFieldsPaginatorOptions)) *ListFieldsPaginator

NewListFieldsPaginator returns a new ListFieldsPaginator

func (*ListFieldsPaginator) HasMorePages 

func (p *ListFieldsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFieldsPaginator) NextPage 

func (p *ListFieldsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFieldsOutput, error)

NextPage retrieves the next ListFields page.

type ListFieldsPaginatorOptions 

type ListFieldsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFieldsPaginatorOptions is the paginator options for ListFields

type ListLayoutsAPIClient 

type ListLayoutsAPIClient interface {
	ListLayouts(context.Context, *ListLayoutsInput, ...func(*Options)) (*ListLayoutsOutput, error)
}

ListLayoutsAPIClient is a client that implements the ListLayouts operation.

type ListLayoutsInput 

type ListLayoutsInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLayoutsOutput 

type ListLayoutsOutput struct {

	// The layouts for the domain.
	//
	// This member is required.
	Layouts []types.LayoutSummary

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLayoutsPaginator 

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

ListLayoutsPaginator is a paginator for ListLayouts

func NewListLayoutsPaginator 

func NewListLayoutsPaginator(client ListLayoutsAPIClient, params *ListLayoutsInput, optFns ...func(*ListLayoutsPaginatorOptions)) *ListLayoutsPaginator

NewListLayoutsPaginator returns a new ListLayoutsPaginator

func (*ListLayoutsPaginator) HasMorePages 

func (p *ListLayoutsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLayoutsPaginator) NextPage 

func (p *ListLayoutsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLayoutsOutput, error)

NextPage retrieves the next ListLayouts page.

type ListLayoutsPaginatorOptions 

type ListLayoutsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLayoutsPaginatorOptions is the paginator options for ListLayouts

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN)
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A map of of key-value pairs that represent tags on a resource. Tags are used to
	// organize, track, or control access for this resource.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplatesAPIClient 

type ListTemplatesAPIClient interface {
	ListTemplates(context.Context, *ListTemplatesInput, ...func(*Options)) (*ListTemplatesOutput, error)
}

ListTemplatesAPIClient is a client that implements the ListTemplates operation.

type ListTemplatesInput 

type ListTemplatesInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// A list of status values to filter on.
	Status []types.TemplateStatus
	// contains filtered or unexported fields
}

type ListTemplatesOutput 

type ListTemplatesOutput struct {

	// List of template summary objects.
	//
	// This member is required.
	Templates []types.TemplateSummary

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplatesPaginator 

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

ListTemplatesPaginator is a paginator for ListTemplates

func NewListTemplatesPaginator 

func NewListTemplatesPaginator(client ListTemplatesAPIClient, params *ListTemplatesInput, optFns ...func(*ListTemplatesPaginatorOptions)) *ListTemplatesPaginator

NewListTemplatesPaginator returns a new ListTemplatesPaginator

func (*ListTemplatesPaginator) HasMorePages 

func (p *ListTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTemplatesPaginator) NextPage 

func (p *ListTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplatesOutput, error)

NextPage retrieves the next ListTemplates page.

type ListTemplatesPaginatorOptions 

type ListTemplatesPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTemplatesPaginatorOptions is the paginator options for ListTemplates

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.11.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutCaseEventConfigurationInput 

type PutCaseEventConfigurationInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// Configuration to enable EventBridge case event delivery and determine what data
	// is delivered.
	//
	// This member is required.
	EventBridge *types.EventBridgeConfiguration
	// contains filtered or unexported fields
}

type PutCaseEventConfigurationOutput 

type PutCaseEventConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchCasesAPIClient 

type SearchCasesAPIClient interface {
	SearchCases(context.Context, *SearchCasesInput, ...func(*Options)) (*SearchCasesOutput, error)
}

SearchCasesAPIClient is a client that implements the SearchCases operation.

type SearchCasesInput 

type SearchCasesInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The list of field identifiers to be returned as part of the response.
	Fields []types.FieldIdentifier

	// A list of filter objects.
	Filter types.CaseFilter

	// The maximum number of cases to return. The current maximum supported value is
	// 25. This is also the default value when no other value is provided.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// A word or phrase used to perform a quick search.
	SearchTerm *string

	// A list of sorts where each sort specifies a field and their sort order to be
	// applied to the results.
	Sorts []types.Sort
	// contains filtered or unexported fields
}

type SearchCasesOutput 

type SearchCasesOutput struct {

	// A list of case documents where each case contains the properties CaseId and
	// Fields where each field is a complex union structure.
	//
	// This member is required.
	Cases []*types.SearchCasesResponseItem

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchCasesPaginator 

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

SearchCasesPaginator is a paginator for SearchCases

func NewSearchCasesPaginator 

func NewSearchCasesPaginator(client SearchCasesAPIClient, params *SearchCasesInput, optFns ...func(*SearchCasesPaginatorOptions)) *SearchCasesPaginator

NewSearchCasesPaginator returns a new SearchCasesPaginator

func (*SearchCasesPaginator) HasMorePages 

func (p *SearchCasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchCasesPaginator) NextPage 

func (p *SearchCasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchCasesOutput, error)

NextPage retrieves the next SearchCases page.

type SearchCasesPaginatorOptions 

type SearchCasesPaginatorOptions struct {
	// The maximum number of cases to return. The current maximum supported value is
	// 25. This is also the default value when no other value is provided.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchCasesPaginatorOptions is the paginator options for SearchCases

type SearchRelatedItemsAPIClient 

type SearchRelatedItemsAPIClient interface {
	SearchRelatedItems(context.Context, *SearchRelatedItemsInput, ...func(*Options)) (*SearchRelatedItemsOutput, error)
}

SearchRelatedItemsAPIClient is a client that implements the SearchRelatedItems operation.

type SearchRelatedItemsInput 

type SearchRelatedItemsInput struct {

	// A unique identifier of the case.
	//
	// This member is required.
	CaseId *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The list of types of related items and their parameters to use for filtering.
	Filters []types.RelatedItemTypeFilter

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchRelatedItemsOutput 

type SearchRelatedItemsOutput struct {

	// A list of items related to a case.
	//
	// This member is required.
	RelatedItems []*types.SearchRelatedItemsResponseItem

	// The token for the next set of results. This is null if there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchRelatedItemsPaginator 

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

SearchRelatedItemsPaginator is a paginator for SearchRelatedItems

func NewSearchRelatedItemsPaginator 

func NewSearchRelatedItemsPaginator(client SearchRelatedItemsAPIClient, params *SearchRelatedItemsInput, optFns ...func(*SearchRelatedItemsPaginatorOptions)) *SearchRelatedItemsPaginator

NewSearchRelatedItemsPaginator returns a new SearchRelatedItemsPaginator

func (*SearchRelatedItemsPaginator) HasMorePages 

func (p *SearchRelatedItemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchRelatedItemsPaginator) NextPage 

func (p *SearchRelatedItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchRelatedItemsOutput, error)

NextPage retrieves the next SearchRelatedItems page.

type SearchRelatedItemsPaginatorOptions 

type SearchRelatedItemsPaginatorOptions struct {
	// The maximum number of results to return per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchRelatedItemsPaginatorOptions is the paginator options for SearchRelatedItems

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN)
	//
	// This member is required.
	Arn *string

	// A map of of key-value pairs that represent tags on a resource. Tags are used to
	// organize, track, or control access for this resource.
	//
	// This member is required.
	Tags map[string]*string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN)
	//
	// This member is required.
	Arn *string

	// List of tag keys.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCaseInput 

type UpdateCaseInput struct {

	// A unique identifier of the case.
	//
	// This member is required.
	CaseId *string

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// An array of objects with fieldId (matching ListFields/DescribeField) and value
	// union data, structured identical to CreateCase .
	//
	// This member is required.
	Fields []types.FieldValue

	// Represents the identity of the person who performed the action.
	PerformedBy types.UserUnion
	// contains filtered or unexported fields
}

type UpdateCaseOutput 

type UpdateCaseOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFieldInput 

type UpdateFieldInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The unique identifier of a field.
	//
	// This member is required.
	FieldId *string

	// The description of a field.
	Description *string

	// The name of the field.
	Name *string
	// contains filtered or unexported fields
}

type UpdateFieldOutput 

type UpdateFieldOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLayoutInput 

type UpdateLayoutInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// The unique identifier of the layout.
	//
	// This member is required.
	LayoutId *string

	// Information about which fields will be present in the layout, the order of the
	// fields.
	Content types.LayoutContent

	// The name of the layout. It must be unique per domain.
	Name *string
	// contains filtered or unexported fields
}

type UpdateLayoutOutput 

type UpdateLayoutOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTemplateInput 

type UpdateTemplateInput struct {

	// The unique identifier of the Cases domain.
	//
	// This member is required.
	DomainId *string

	// A unique identifier for the template.
	//
	// This member is required.
	TemplateId *string

	// A brief description of the template.
	Description *string

	// Configuration of layouts associated to the template.
	LayoutConfiguration *types.LayoutConfiguration

	// The name of the template. It must be unique per domain.
	Name *string

	// A list of fields that must contain a value for a case to be successfully
	// created with this template.
	RequiredFields []types.RequiredField

	// The status of the template.
	Status types.TemplateStatus
	// contains filtered or unexported fields
}

type UpdateTemplateOutput 

type UpdateTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.