From 966cbb52c5f57fac372361e85883fdaa5bc9bc1c Mon Sep 17 00:00:00 2001 From: Renovate Bot Date: Fri, 28 Jun 2019 19:59:30 +0000 Subject: [PATCH] chore(deps): update module aws/aws-sdk-go to v1.20.12 --- go.mod | 2 +- go.sum | 4 +- .../aws/aws-sdk-go/aws/endpoints/defaults.go | 37 +- .../github.com/aws/aws-sdk-go/aws/version.go | 2 +- .../aws-sdk-go/service/apigatewayv2/api.go | 560 ++ .../aws/aws-sdk-go/service/codecommit/api.go | 108 +- .../aws/aws-sdk-go/service/codecommit/doc.go | 14 +- .../aws-sdk-go/service/codecommit/errors.go | 10 +- .../aws-sdk-go/service/directconnect/api.go | 438 +- .../aws/aws-sdk-go/service/dynamodb/api.go | 421 +- .../aws/aws-sdk-go/service/dynamodb/errors.go | 4 + .../aws/aws-sdk-go/service/ec2/api.go | 212 +- .../aws/aws-sdk-go/service/pinpoint/api.go | 5581 +++++++++++------ .../aws/aws-sdk-go/service/pinpoint/doc.go | 2 + .../aws/aws-sdk-go/service/pinpoint/errors.go | 12 +- .../aws/aws-sdk-go/service/redshift/api.go | 28 + .../aws/aws-sdk-go/service/workspaces/api.go | 240 +- vendor/modules.txt | 2 +- 18 files changed, 5364 insertions(+), 2313 deletions(-) diff --git a/go.mod b/go.mod index 9fd5cf56b40..e29f6fe147e 100644 --- a/go.mod +++ b/go.mod @@ -1,7 +1,7 @@ module github.com/terraform-providers/terraform-provider-aws require ( - github.com/aws/aws-sdk-go v1.20.8 + github.com/aws/aws-sdk-go v1.20.12 github.com/beevik/etree v1.1.0 github.com/bflad/tfproviderlint v0.4.0 github.com/client9/misspell v0.3.4 diff --git a/go.sum b/go.sum index c11de43d1b8..dd29d287d63 100644 --- a/go.sum +++ b/go.sum @@ -52,8 +52,8 @@ github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgI github.com/aws/aws-sdk-go v1.15.78/go.mod h1:E3/ieXAlvM0XWO57iftYVDLLvQ824smPP3ATZkfNZeM= github.com/aws/aws-sdk-go v1.16.36/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo= github.com/aws/aws-sdk-go v1.19.18/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo= -github.com/aws/aws-sdk-go v1.20.8 h1:oXnNFH/8PosUvHXqZHYLUn6LCSzHZ/34H52vrB4YhpA= -github.com/aws/aws-sdk-go v1.20.8/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo= +github.com/aws/aws-sdk-go v1.20.12 h1:xV7xfLSkiqd7JOnLlfER+Jz8kI98rAGJvtXssYkCRs4= +github.com/aws/aws-sdk-go v1.20.12/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo= github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f/go.mod h1:AuiFmCCPBSrqvVMvuqFuk0qogytodnVFVSN5CeJB8Gc= github.com/beevik/etree v1.1.0 h1:T0xke/WvNtMoCqgzPhkX2r4rjY3GDZFi+FjpRZY2Jbs= github.com/beevik/etree v1.1.0/go.mod h1:r8Aw8JqVegEf0w2fDnATrX9VpkMcyFeM0FhwO62wh+A= diff --git a/vendor/github.com/aws/aws-sdk-go/aws/endpoints/defaults.go b/vendor/github.com/aws/aws-sdk-go/aws/endpoints/defaults.go index 989f8dfda8e..8afbea42972 100644 --- a/vendor/github.com/aws/aws-sdk-go/aws/endpoints/defaults.go +++ b/vendor/github.com/aws/aws-sdk-go/aws/endpoints/defaults.go @@ -536,17 +536,24 @@ var awsPartition = partition{ "backup": service{ Endpoints: endpoints{ + "ap-northeast-1": endpoint{}, + "ap-northeast-2": endpoint{}, + "ap-southeast-1": endpoint{}, "ap-southeast-2": endpoint{}, + "ca-central-1": endpoint{}, "eu-central-1": endpoint{}, "eu-west-1": endpoint{}, + "eu-west-2": endpoint{}, "us-east-1": endpoint{}, "us-east-2": endpoint{}, + "us-west-1": endpoint{}, "us-west-2": endpoint{}, }, }, "batch": service{ Endpoints: endpoints{ + "ap-east-1": endpoint{}, "ap-northeast-1": endpoint{}, "ap-northeast-2": endpoint{}, "ap-south-1": endpoint{}, @@ -1556,6 +1563,7 @@ var awsPartition = partition{ Endpoints: endpoints{ "ap-northeast-1": endpoint{}, + "ap-southeast-1": endpoint{}, "ap-southeast-2": endpoint{}, "eu-central-1": endpoint{}, "eu-west-1": endpoint{}, @@ -1618,6 +1626,7 @@ var awsPartition = partition{ "ap-southeast-2": endpoint{}, "ca-central-1": endpoint{}, "eu-central-1": endpoint{}, + "eu-north-1": endpoint{}, "eu-west-1": endpoint{}, "eu-west-2": endpoint{}, "eu-west-3": endpoint{}, @@ -1833,12 +1842,6 @@ var awsPartition = partition{ "kms": service{ Endpoints: endpoints{ - "ProdFips": endpoint{ - Hostname: "kms-fips.ca-central-1.amazonaws.com", - CredentialScope: credentialScope{ - Region: "ca-central-1", - }, - }, "ap-east-1": endpoint{}, "ap-northeast-1": endpoint{}, "ap-northeast-2": endpoint{}, @@ -3248,9 +3251,15 @@ var awsPartition = partition{ }, }, "support": service{ + PartitionEndpoint: "aws-global", Endpoints: endpoints{ - "aws-global": endpoint{}, + "aws-global": endpoint{ + Hostname: "support.us-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-east-1", + }, + }, }, }, "swf": service{ @@ -3892,6 +3901,18 @@ var awscnPartition = partition{ "cn-northwest-1": endpoint{}, }, }, + "support": service{ + PartitionEndpoint: "aws-cn-global", + + Endpoints: endpoints{ + "aws-cn-global": endpoint{ + Hostname: "support.cn-north-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "cn-north-1", + }, + }, + }, + }, "swf": service{ Endpoints: endpoints{ @@ -4234,6 +4255,7 @@ var awsusgovPartition = partition{ "firehose": service{ Endpoints: endpoints{ + "us-gov-east-1": endpoint{}, "us-gov-west-1": endpoint{}, }, }, @@ -4249,6 +4271,7 @@ var awsusgovPartition = partition{ "glue": service{ Endpoints: endpoints{ + "us-gov-east-1": endpoint{}, "us-gov-west-1": endpoint{}, }, }, diff --git a/vendor/github.com/aws/aws-sdk-go/aws/version.go b/vendor/github.com/aws/aws-sdk-go/aws/version.go index f4bc50fd272..07be5dc51ad 100644 --- a/vendor/github.com/aws/aws-sdk-go/aws/version.go +++ b/vendor/github.com/aws/aws-sdk-go/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.20.8" +const SDKVersion = "1.20.12" diff --git a/vendor/github.com/aws/aws-sdk-go/service/apigatewayv2/api.go b/vendor/github.com/aws/aws-sdk-go/service/apigatewayv2/api.go index b194a3c4c79..f611e9ec3d3 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/apigatewayv2/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/apigatewayv2/api.go @@ -3909,6 +3909,280 @@ func (c *ApiGatewayV2) GetStagesWithContext(ctx aws.Context, input *GetStagesInp return out, req.Send() } +const opGetTags = "GetTags" + +// GetTagsRequest generates a "aws/request.Request" representing the +// client's request for the GetTags 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 GetTags for more information on using the GetTags +// 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 GetTagsRequest method. +// req, resp := client.GetTagsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/GetTags +func (c *ApiGatewayV2) GetTagsRequest(input *GetTagsInput) (req *request.Request, output *GetTagsOutput) { + op := &request.Operation{ + Name: opGetTags, + HTTPMethod: "GET", + HTTPPath: "/v2/tags/{resource-arn}", + } + + if input == nil { + input = &GetTagsInput{} + } + + output = &GetTagsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetTags API operation for AmazonApiGatewayV2. +// +// Gets the Tags for a resource. +// +// 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 AmazonApiGatewayV2's +// API operation GetTags for usage and error information. +// +// Returned Error Codes: +// * ErrCodeNotFoundException "NotFoundException" +// The resource specified in the request was not found. See the message field +// for more information. +// +// * ErrCodeTooManyRequestsException "TooManyRequestsException" +// A limit has been exceeded. See the accompanying error message for details. +// +// * ErrCodeBadRequestException "BadRequestException" +// The request is not valid, for example, the input is incomplete or incorrect. +// See the accompanying error message for details. +// +// * ErrCodeConflictException "ConflictException" +// The requested operation would cause a conflict with the current state of +// a service resource associated with the request. Resolve the conflict before +// retrying this request. See the accompanying error message for details. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/GetTags +func (c *ApiGatewayV2) GetTags(input *GetTagsInput) (*GetTagsOutput, error) { + req, out := c.GetTagsRequest(input) + return out, req.Send() +} + +// GetTagsWithContext is the same as GetTags with the addition of +// the ability to pass a context and additional request options. +// +// See GetTags for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ApiGatewayV2) GetTagsWithContext(ctx aws.Context, input *GetTagsInput, opts ...request.Option) (*GetTagsOutput, error) { + req, out := c.GetTagsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource 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 TagResource for more information on using the TagResource +// 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 TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/TagResource +func (c *ApiGatewayV2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/v2/tags/{resource-arn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AmazonApiGatewayV2. +// +// 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 AmazonApiGatewayV2's +// API operation TagResource for usage and error information. +// +// Returned Error Codes: +// * ErrCodeNotFoundException "NotFoundException" +// The resource specified in the request was not found. See the message field +// for more information. +// +// * ErrCodeTooManyRequestsException "TooManyRequestsException" +// A limit has been exceeded. See the accompanying error message for details. +// +// * ErrCodeBadRequestException "BadRequestException" +// The request is not valid, for example, the input is incomplete or incorrect. +// See the accompanying error message for details. +// +// * ErrCodeConflictException "ConflictException" +// The requested operation would cause a conflict with the current state of +// a service resource associated with the request. Resolve the conflict before +// retrying this request. See the accompanying error message for details. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/TagResource +func (c *ApiGatewayV2) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ApiGatewayV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource 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 UntagResource for more information on using the UntagResource +// 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 UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/UntagResource +func (c *ApiGatewayV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/v2/tags/{resource-arn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AmazonApiGatewayV2. +// +// 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 AmazonApiGatewayV2's +// API operation UntagResource for usage and error information. +// +// Returned Error Codes: +// * ErrCodeNotFoundException "NotFoundException" +// The resource specified in the request was not found. See the message field +// for more information. +// +// * ErrCodeTooManyRequestsException "TooManyRequestsException" +// A limit has been exceeded. See the accompanying error message for details. +// +// * ErrCodeBadRequestException "BadRequestException" +// The request is not valid, for example, the input is incomplete or incorrect. +// See the accompanying error message for details. +// +// * ErrCodeConflictException "ConflictException" +// The requested operation would cause a conflict with the current state of +// a service resource associated with the request. Resolve the conflict before +// retrying this request. See the accompanying error message for details. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/UntagResource +func (c *ApiGatewayV2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ApiGatewayV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateApi = "UpdateApi" // UpdateApiRequest generates a "aws/request.Request" representing the @@ -4994,6 +5268,9 @@ type Api struct { // RouteSelectionExpression is a required field RouteSelectionExpression *string `locationName:"routeSelectionExpression" type:"string" required:"true"` + // Tags for the API. + Tags map[string]*string `locationName:"tags" type:"map"` + // A version identifier for the API. Version *string `locationName:"version" type:"string"` @@ -5066,6 +5343,12 @@ func (s *Api) SetRouteSelectionExpression(v string) *Api { return s } +// SetTags sets the Tags field's value. +func (s *Api) SetTags(v map[string]*string) *Api { + s.Tags = v + return s +} + // SetVersion sets the Version field's value. func (s *Api) SetVersion(v string) *Api { s.Version = &v @@ -5983,6 +6266,10 @@ type CreateDomainNameInput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -6020,6 +6307,12 @@ func (s *CreateDomainNameInput) SetDomainNameConfigurations(v []*DomainNameConfi return s } +// SetTags sets the Tags field's value. +func (s *CreateDomainNameInput) SetTags(v map[string]*string) *CreateDomainNameInput { + s.Tags = v + return s +} + type CreateDomainNameOutput struct { _ struct{} `type:"structure"` @@ -6033,6 +6326,10 @@ type CreateDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -6063,6 +6360,12 @@ func (s *CreateDomainNameOutput) SetDomainNameConfigurations(v []*DomainNameConf return s } +// SetTags sets the Tags field's value. +func (s *CreateDomainNameOutput) SetTags(v map[string]*string) *CreateDomainNameOutput { + s.Tags = v + return s +} + type CreateIntegrationInput struct { _ struct{} `type:"structure"` @@ -7246,6 +7549,10 @@ type CreateStageInput struct { // The stage variable map. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -7331,6 +7638,12 @@ func (s *CreateStageInput) SetStageVariables(v map[string]*string) *CreateStageI return s } +// SetTags sets the Tags field's value. +func (s *CreateStageInput) SetTags(v map[string]*string) *CreateStageInput { + s.Tags = v + return s +} + type CreateStageOutput struct { _ struct{} `type:"structure"` @@ -7361,6 +7674,10 @@ type CreateStageOutput struct { // The stage variable map. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -7433,6 +7750,12 @@ func (s *CreateStageOutput) SetStageVariables(v map[string]*string) *CreateStage return s } +// SetTags sets the Tags field's value. +func (s *CreateStageOutput) SetTags(v map[string]*string) *CreateStageOutput { + s.Tags = v + return s +} + type DeleteApiInput struct { _ struct{} `type:"structure"` @@ -8256,6 +8579,9 @@ type DomainName struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + + // Tags for the DomainName. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -8286,6 +8612,12 @@ func (s *DomainName) SetDomainNameConfigurations(v []*DomainNameConfiguration) * return s } +// SetTags sets the Tags field's value. +func (s *DomainName) SetTags(v map[string]*string) *DomainName { + s.Tags = v + return s +} + // The domain name configuration. type DomainNameConfiguration struct { _ struct{} `type:"structure"` @@ -8654,6 +8986,10 @@ type GetApiOutput struct { // for more information. RouteSelectionExpression *string `locationName:"routeSelectionExpression" type:"string"` + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` + // A string with a length between [1-64]. Version *string `locationName:"version" type:"string"` @@ -8724,6 +9060,12 @@ func (s *GetApiOutput) SetRouteSelectionExpression(v string) *GetApiOutput { return s } +// SetTags sets the Tags field's value. +func (s *GetApiOutput) SetTags(v map[string]*string) *GetApiOutput { + s.Tags = v + return s +} + // SetVersion sets the Version field's value. func (s *GetApiOutput) SetVersion(v string) *GetApiOutput { s.Version = &v @@ -9297,6 +9639,10 @@ type GetDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -9327,6 +9673,12 @@ func (s *GetDomainNameOutput) SetDomainNameConfigurations(v []*DomainNameConfigu return s } +// SetTags sets the Tags field's value. +func (s *GetDomainNameOutput) SetTags(v map[string]*string) *GetDomainNameOutput { + s.Tags = v + return s +} + type GetDomainNamesInput struct { _ struct{} `type:"structure"` @@ -10824,6 +11176,10 @@ type GetStageOutput struct { // The stage variable map. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -10896,6 +11252,12 @@ func (s *GetStageOutput) SetStageVariables(v map[string]*string) *GetStageOutput return s } +// SetTags sets the Tags field's value. +func (s *GetStageOutput) SetTags(v map[string]*string) *GetStageOutput { + s.Tags = v + return s +} + type GetStagesInput struct { _ struct{} `type:"structure"` @@ -10983,6 +11345,67 @@ func (s *GetStagesOutput) SetNextToken(v string) *GetStagesOutput { return s } +type GetTagsInput struct { + _ struct{} `type:"structure"` + + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetTagsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetTagsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetTagsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetTagsInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *GetTagsInput) SetResourceArn(v string) *GetTagsInput { + s.ResourceArn = &v + return s +} + +type GetTagsOutput struct { + _ struct{} `type:"structure"` + + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s GetTagsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetTagsOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *GetTagsOutput) SetTags(v map[string]*string) *GetTagsOutput { + s.Tags = v + return s +} + // Represents an integration. type Integration struct { _ struct{} `type:"structure"` @@ -11674,6 +12097,9 @@ type Stage struct { // can have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` + + // Tags for the Stage. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation @@ -11746,6 +12172,140 @@ func (s *Stage) SetStageVariables(v map[string]*string) *Stage { return s } +// SetTags sets the Tags field's value. +func (s *Stage) SetTags(v map[string]*string) *Stage { + s.Tags = v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"` + + // A key value pair of string with key length between[1-128] and value length + // between[1-256] + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceOutput) GoString() string { + return s.String() +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"` + + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + type UpdateApiInput struct { _ struct{} `type:"structure"` diff --git a/vendor/github.com/aws/aws-sdk-go/service/codecommit/api.go b/vendor/github.com/aws/aws-sdk-go/service/codecommit/api.go index 854a1996b5a..c01e57d240b 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/codecommit/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/codecommit/api.go @@ -121,6 +121,10 @@ func (c *CodeCommit) BatchDescribeMergeConflictsRequest(input *BatchDescribeMerg // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeEncryptionIntegrityChecksFailedException "EncryptionIntegrityChecksFailedException" // An encryption integrity check failed. // @@ -562,8 +566,7 @@ func (c *CodeCommit) CreateCommitRequest(input *CreateCommitInput) (req *request // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -974,9 +977,10 @@ func (c *CodeCommit) CreateUnreferencedMergeCommitRequest(input *CreateUnreferen // CreateUnreferencedMergeCommit API operation for AWS CodeCommit. // -// Creates an unerferenced commit that represents the result of merging two +// Creates an unreferenced commit that represents the result of merging two // branches using a specified merge strategy. This can help you determine the -// outcome of a potential merge. +// outcome of a potential merge. This API cannot be used with the fast-forward +// merge strategy, as that strategy does not create a merge commit. // // This unreferenced merge commit can only be accessed using the GetCommit API // or through git commands such as git fetch. To retrieve this commit, you must @@ -1079,6 +1083,10 @@ func (c *CodeCommit) CreateUnreferencedMergeCommitRequest(input *CreateUnreferen // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeFileModeRequiredException "FileModeRequiredException" // The commit cannot be created because a file mode is required to update mode // permissions for an existing file, but no file mode has been specified. @@ -1089,8 +1097,7 @@ func (c *CodeCommit) CreateUnreferencedMergeCommitRequest(input *CreateUnreferen // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -1458,8 +1465,7 @@ func (c *CodeCommit) DeleteFileRequest(input *DeleteFileInput) (req *request.Req // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -1735,6 +1741,10 @@ func (c *CodeCommit) DescribeMergeConflictsRequest(input *DescribeMergeConflicts // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeEncryptionIntegrityChecksFailedException "EncryptionIntegrityChecksFailedException" // An encryption integrity check failed. // @@ -3477,6 +3487,10 @@ func (c *CodeCommit) GetMergeConflictsRequest(input *GetMergeConflictsInput) (re // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeEncryptionIntegrityChecksFailedException "EncryptionIntegrityChecksFailedException" // An encryption integrity check failed. // @@ -3657,6 +3671,10 @@ func (c *CodeCommit) GetMergeOptionsRequest(input *GetMergeOptionsInput) (req *r // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeEncryptionIntegrityChecksFailedException "EncryptionIntegrityChecksFailedException" // An encryption integrity check failed. // @@ -4886,6 +4904,10 @@ func (c *CodeCommit) MergeBranchesBySquashRequest(input *MergeBranchesBySquashIn // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeFileModeRequiredException "FileModeRequiredException" // The commit cannot be created because a file mode is required to update mode // permissions for an existing file, but no file mode has been specified. @@ -4896,8 +4918,7 @@ func (c *CodeCommit) MergeBranchesBySquashRequest(input *MergeBranchesBySquashIn // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -5097,6 +5118,10 @@ func (c *CodeCommit) MergeBranchesByThreeWayRequest(input *MergeBranchesByThreeW // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeFileModeRequiredException "FileModeRequiredException" // The commit cannot be created because a file mode is required to update mode // permissions for an existing file, but no file mode has been specified. @@ -5107,8 +5132,7 @@ func (c *CodeCommit) MergeBranchesByThreeWayRequest(input *MergeBranchesByThreeW // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -5199,9 +5223,10 @@ func (c *CodeCommit) MergePullRequestByFastForwardRequest(input *MergePullReques // MergePullRequestByFastForward API operation for AWS CodeCommit. // -// Closes a pull request and attempts to merge the source commit of a pull request -// into the specified destination branch for that pull request at the specified -// commit using the fast-forward merge strategy. +// Attempts to merge the source commit of a pull request into the specified +// destination branch for that pull request at the specified commit using the +// fast-forward merge strategy. If the merge is successful, it closes the pull +// request. // // 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 @@ -5340,9 +5365,9 @@ func (c *CodeCommit) MergePullRequestBySquashRequest(input *MergePullRequestBySq // MergePullRequestBySquash API operation for AWS CodeCommit. // -// Closes a pull request and attempts to merge the source commit of a pull request -// into the specified destination branch for that pull request at the specified -// commit using the squash merge strategy. +// Attempts to merge the source commit of a pull request into the specified +// destination branch for that pull request at the specified commit using the +// squash merge strategy. If the merge is successful, it closes the pull request. // // 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 @@ -5386,8 +5411,7 @@ func (c *CodeCommit) MergePullRequestBySquashRequest(input *MergePullRequestBySq // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -5451,6 +5475,10 @@ func (c *CodeCommit) MergePullRequestBySquashRequest(input *MergePullRequestBySq // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeRepositoryNameRequiredException "RepositoryNameRequiredException" // A repository name is required but was not specified. // @@ -5550,9 +5578,10 @@ func (c *CodeCommit) MergePullRequestByThreeWayRequest(input *MergePullRequestBy // MergePullRequestByThreeWay API operation for AWS CodeCommit. // -// Closes a pull request and attempts to merge the source commit of a pull request -// into the specified destination branch for that pull request at the specified -// commit using the three-way merge strategy. +// Attempts to merge the source commit of a pull request into the specified +// destination branch for that pull request at the specified commit using the +// three-way merge strategy. If the merge is successful, it closes the pull +// request. // // 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 @@ -5596,8 +5625,7 @@ func (c *CodeCommit) MergePullRequestByThreeWayRequest(input *MergePullRequestBy // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -5661,6 +5689,10 @@ func (c *CodeCommit) MergePullRequestByThreeWayRequest(input *MergePullRequestBy // * ErrCodeMaximumFileContentToLoadExceededException "MaximumFileContentToLoadExceededException" // The number of files to load exceeds the allowed limit. // +// * ErrCodeMaximumItemsToCompareExceededException "MaximumItemsToCompareExceededException" +// The maximum number of items to compare between the source or destination +// branches and the merge base has exceeded the maximum allowed. +// // * ErrCodeRepositoryNameRequiredException "RepositoryNameRequiredException" // A repository name is required but was not specified. // @@ -6293,8 +6325,7 @@ func (c *CodeCommit) PutFileRequest(input *PutFileInput) (req *request.Request, // // * ErrCodeNameLengthExceededException "NameLengthExceededException" // The user name is not valid because it has exceeded the character limit for -// file names. File names, including the path to the file, cannot exceed the -// character limit. +// author names. // // * ErrCodeInvalidEmailException "InvalidEmailException" // The specified email address either contains one or more characters that are @@ -8487,8 +8518,8 @@ type ConflictMetadata struct { // The number of conflicts, including both hunk conflicts and metadata conflicts. NumberOfConflicts *int64 `locationName:"numberOfConflicts" type:"integer"` - // A boolean value (true or false) indicating whether there are conflicts in - // the object type of a file. + // A boolean value (true or false) indicating whether there are conflicts between + // the branches in the object type of a file, folder, or submodule. ObjectTypeConflict *bool `locationName:"objectTypeConflict" type:"boolean"` // Information about any object type conflicts in a merge operation. @@ -8573,7 +8604,7 @@ type ConflictResolution struct { // Files that will be deleted as part of the merge conflict resolution. DeleteFiles []*DeleteFileEntry `locationName:"deleteFiles" type:"list"` - // Information about how a conflict in a merge will be resolved. + // Files that will have content replaced as part of the merge conflict resolution. ReplaceContents []*ReplaceContentEntry `locationName:"replaceContents" type:"list"` // File modes that will be set as part of the merge conflict resolution. @@ -11711,7 +11742,8 @@ type GetMergeConflictsOutput struct { // The commit ID of the merge base. BaseCommitId *string `locationName:"baseCommitId" type:"string"` - // A list of metadata for any conflicts found. + // A list of metadata for any conflicting files. If the specified merge strategy + // is FAST_FORWARD_MERGE, this list will always be empty. // // ConflictMetadataList is a required field ConflictMetadataList []*ConflictMetadata `locationName:"conflictMetadataList" type:"list" required:"true"` @@ -13116,7 +13148,9 @@ type MergeHunk struct { // A Boolean value indicating whether a combination of hunks contains a conflict. // Conflicts occur when the same file or the same lines in a file were modified // in both the source and destination of a merge or pull request. Valid values - // include true, false, and null. + // include true, false, and null. This will be true when the hunk represents + // a conflict and one or more files contains a line conflict. File mode conflicts + // in a merge will not set this to be true. IsConflict *bool `locationName:"isConflict" type:"boolean"` // Information about the merge hunk in the source of a merge or pull request. @@ -13162,13 +13196,14 @@ func (s *MergeHunk) SetSource(v *MergeHunkDetail) *MergeHunk { type MergeHunkDetail struct { _ struct{} `type:"structure"` - // The line number where a merge conflict ends. + // The end position of the hunk in the merge result. EndLine *int64 `locationName:"endLine" type:"integer"` - // The base-64 encoded content of the hunk that contains the conflict. + // The base-64 encoded content of the hunk merged region that might or might + // not contain a conflict. HunkContent *string `locationName:"hunkContent" type:"string"` - // The line number where a merge conflict begins. + // The start position of the hunk in the merge result. StartLine *int64 `locationName:"startLine" type:"integer"` } @@ -13767,6 +13802,9 @@ type PostCommentForComparedCommitInput struct { // To establish the directionality of the comparison, the full commit ID of // the 'before' commit. + // + // This is required for commenting on any commit unless that commit is the initial + // commit. BeforeCommitId *string `locationName:"beforeCommitId" type:"string"` // A unique, client-generated idempotency token that when provided in a request, diff --git a/vendor/github.com/aws/aws-sdk-go/service/codecommit/doc.go b/vendor/github.com/aws/aws-sdk-go/service/codecommit/doc.go index 685d6be49d8..9a9e7a37e01 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/codecommit/doc.go +++ b/vendor/github.com/aws/aws-sdk-go/service/codecommit/doc.go @@ -48,20 +48,20 @@ // * DeleteFile, which deletes the content of a specified file from a specified // branch. // +// * GetBlob, which returns the base-64 encoded content of an individual +// Git blob object within a repository. +// // * GetFile, which returns the base-64 encoded content of a specified file. // // * GetFolder, which returns the contents of a specified folder or directory. // -// * PutFile, which adds or modifies a file in a specified repository and -// branch. +// * PutFile, which adds or modifies a single file in a specified repository +// and branch. // -// Information about committed code in a repository, by calling the following: +// Commits, by calling the following: // // * CreateCommit, which creates a commit for changes to a repository. // -// * GetBlob, which returns the base-64 encoded content of an individual -// Git blob object within a repository. -// // * GetCommit, which returns information about a commit, including commit // messages and author and committer information. // @@ -136,7 +136,7 @@ // // * UpdatePullRequestTitle, which updates the title of a pull request. // -// Information about comments in a repository, by calling the following: +// Comments in a repository, by calling the following: // // * DeleteCommentContent, which deletes the content of a comment on a commit // in a repository. diff --git a/vendor/github.com/aws/aws-sdk-go/service/codecommit/errors.go b/vendor/github.com/aws/aws-sdk-go/service/codecommit/errors.go index 5294b196623..a82df22292e 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/codecommit/errors.go +++ b/vendor/github.com/aws/aws-sdk-go/service/codecommit/errors.go @@ -667,6 +667,13 @@ const ( // using a Git client for these changes. ErrCodeMaximumFileEntriesExceededException = "MaximumFileEntriesExceededException" + // ErrCodeMaximumItemsToCompareExceededException for service response error code + // "MaximumItemsToCompareExceededException". + // + // The maximum number of items to compare between the source or destination + // branches and the merge base has exceeded the maximum allowed. + ErrCodeMaximumItemsToCompareExceededException = "MaximumItemsToCompareExceededException" + // ErrCodeMaximumOpenPullRequestsExceededException for service response error code // "MaximumOpenPullRequestsExceededException". // @@ -713,8 +720,7 @@ const ( // "NameLengthExceededException". // // The user name is not valid because it has exceeded the character limit for - // file names. File names, including the path to the file, cannot exceed the - // character limit. + // author names. ErrCodeNameLengthExceededException = "NameLengthExceededException" // ErrCodeNoChangeException for service response error code diff --git a/vendor/github.com/aws/aws-sdk-go/service/directconnect/api.go b/vendor/github.com/aws/aws-sdk-go/service/directconnect/api.go index 22c7465fbaa..96c0a66b4fa 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/directconnect/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/directconnect/api.go @@ -257,6 +257,12 @@ func (c *DirectConnect) AllocateHostedConnectionRequest(input *AllocateHostedCon // API operation AllocateHostedConnection for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -343,6 +349,12 @@ func (c *DirectConnect) AllocatePrivateVirtualInterfaceRequest(input *AllocatePr // API operation AllocatePrivateVirtualInterface for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -437,6 +449,12 @@ func (c *DirectConnect) AllocatePublicVirtualInterfaceRequest(input *AllocatePub // API operation AllocatePublicVirtualInterface for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -529,6 +547,12 @@ func (c *DirectConnect) AllocateTransitVirtualInterfaceRequest(input *AllocateTr // API operation AllocateTransitVirtualInterface for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -1343,6 +1367,12 @@ func (c *DirectConnect) CreateConnectionRequest(input *CreateConnectionInput) (r // API operation CreateConnection for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -1707,6 +1737,12 @@ func (c *DirectConnect) CreateInterconnectRequest(input *CreateInterconnectInput // API operation CreateInterconnect for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -1813,6 +1849,12 @@ func (c *DirectConnect) CreateLagRequest(input *CreateLagInput) (req *request.Re // API operation CreateLag for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -1901,6 +1943,12 @@ func (c *DirectConnect) CreatePrivateVirtualInterfaceRequest(input *CreatePrivat // API operation CreatePrivateVirtualInterface for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -1989,6 +2037,12 @@ func (c *DirectConnect) CreatePublicVirtualInterfaceRequest(input *CreatePublicV // API operation CreatePublicVirtualInterface for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -2061,11 +2115,17 @@ func (c *DirectConnect) CreateTransitVirtualInterfaceRequest(input *CreateTransi // CreateTransitVirtualInterface API operation for AWS Direct Connect. // -// Creates a transit virtual interface. A transit virtual interface is a VLAN -// that transports traffic from a Direct Connect gateway to one or more transit +// Creates a transit virtual interface. A transit virtual interface should be +// used to access one or more transit gateways associated with Direct Connect // gateways. A transit virtual interface enables the connection of multiple // VPCs attached to a transit gateway to a Direct Connect gateway. // +// If you associate your transit gateway with one or more Direct Connect gateways, +// the Autonomous System Number (ASN) used by the transit gateway and the Direct +// Connect gateway must be different. For example, if you use the default ASN +// 64512 for both your the transit gateway and Direct Connect gateway, the association +// request fails. +// // 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. @@ -2074,6 +2134,12 @@ func (c *DirectConnect) CreateTransitVirtualInterfaceRequest(input *CreateTransi // API operation CreateTransitVirtualInterface for usage and error information. // // Returned Error Codes: +// * ErrCodeDuplicateTagKeysException "DuplicateTagKeysException" +// A tag key was specified more than once. +// +// * ErrCodeTooManyTagsException "TooManyTagsException" +// You have reached the limit on the number of tags that can be assigned. +// // * ErrCodeServerException "DirectConnectServerException" // A server-side error occurred. // @@ -4720,8 +4786,10 @@ type AcceptDirectConnectGatewayAssociationProposalInput struct { // DirectConnectGatewayId is a required field DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string" required:"true"` - // Overrides the existing Amazon VPC prefixes advertised to the Direct Connect - // gateway. + // Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway. + // + // For information about how to set the prefixes, see Allowed Prefixes (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) + // in the AWS Direct Connect User Guide. OverrideAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix `locationName:"overrideAllowedPrefixesToDirectConnectGateway" type:"list"` // The ID of the request proposal. @@ -4931,6 +4999,9 @@ type AllocateHostedConnectionInput struct { // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` + // The tags to assign to the hosted connection. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The dedicated VLAN provisioned to the hosted connection. // // Vlan is a required field @@ -4962,9 +5033,22 @@ func (s *AllocateHostedConnectionInput) Validate() error { if s.OwnerAccount == nil { invalidParams.Add(request.NewErrParamRequired("OwnerAccount")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } if s.Vlan == nil { invalidParams.Add(request.NewErrParamRequired("Vlan")) } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -4996,6 +5080,12 @@ func (s *AllocateHostedConnectionInput) SetOwnerAccount(v string) *AllocateHoste return s } +// SetTags sets the Tags field's value. +func (s *AllocateHostedConnectionInput) SetTags(v []*Tag) *AllocateHostedConnectionInput { + s.Tags = v + return s +} + // SetVlan sets the Vlan field's value. func (s *AllocateHostedConnectionInput) SetVlan(v int64) *AllocateHostedConnectionInput { s.Vlan = &v @@ -5185,6 +5275,11 @@ func (s *AllocateTransitVirtualInterfaceInput) Validate() error { if s.OwnerAccount == nil { invalidParams.Add(request.NewErrParamRequired("OwnerAccount")) } + if s.NewTransitVirtualInterfaceAllocation != nil { + if err := s.NewTransitVirtualInterfaceAllocation.Validate(); err != nil { + invalidParams.AddNested("NewTransitVirtualInterfaceAllocation", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -5454,7 +5549,8 @@ type BGPPeer struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Asn *int64 `locationName:"asn" type:"integer"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The Direct Connect endpoint on which the BGP peer terminates. @@ -6014,6 +6110,9 @@ type Connection struct { // The AWS Region where the connection is located. Region *string `locationName:"region" type:"string"` + // Any tags assigned to the connection. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The ID of the VLAN. Vlan *int64 `locationName:"vlan" type:"integer"` } @@ -6112,6 +6211,12 @@ func (s *Connection) SetRegion(v string) *Connection { return s } +// SetTags sets the Tags field's value. +func (s *Connection) SetTags(v []*Tag) *Connection { + s.Tags = v + return s +} + // SetVlan sets the Vlan field's value. func (s *Connection) SetVlan(v int64) *Connection { s.Vlan = &v @@ -6216,6 +6321,9 @@ type CreateConnectionInput struct { // // Location is a required field Location *string `locationName:"location" type:"string" required:"true"` + + // The tags to assign to the connection. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` } // String returns the string representation @@ -6240,6 +6348,19 @@ func (s *CreateConnectionInput) Validate() error { if s.Location == nil { invalidParams.Add(request.NewErrParamRequired("Location")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6271,10 +6392,19 @@ func (s *CreateConnectionInput) SetLocation(v string) *CreateConnectionInput { return s } +// SetTags sets the Tags field's value. +func (s *CreateConnectionInput) SetTags(v []*Tag) *CreateConnectionInput { + s.Tags = v + return s +} + type CreateDirectConnectGatewayAssociationInput struct { _ struct{} `type:"structure"` // The Amazon VPC prefixes to advertise to the Direct Connect gateway + // + // For information about how to set the prefixes, see Allowed Prefixes (https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes) + // in the AWS Direct Connect User Guide. AddAllowedPrefixesToDirectConnectGateway []*RouteFilterPrefix `locationName:"addAllowedPrefixesToDirectConnectGateway" type:"list"` // The ID of the Direct Connect gateway. @@ -6559,6 +6689,9 @@ type CreateInterconnectInput struct { // // Location is a required field Location *string `locationName:"location" type:"string" required:"true"` + + // The tags to assign to the interconnect, + Tags []*Tag `locationName:"tags" min:"1" type:"list"` } // String returns the string representation @@ -6583,6 +6716,19 @@ func (s *CreateInterconnectInput) Validate() error { if s.Location == nil { invalidParams.Add(request.NewErrParamRequired("Location")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6614,9 +6760,22 @@ func (s *CreateInterconnectInput) SetLocation(v string) *CreateInterconnectInput return s } +// SetTags sets the Tags field's value. +func (s *CreateInterconnectInput) SetTags(v []*Tag) *CreateInterconnectInput { + s.Tags = v + return s +} + type CreateLagInput struct { _ struct{} `type:"structure"` + // The tags to assign to the child connections of the LAG. Only newly created + // child connections as the result of creating a LAG connection are assigned + // the provided tags. The tags are not assigned to an existing connection that + // is provided via the “connectionId” parameter that will be migrated to + // the LAG. + ChildConnectionTags []*Tag `locationName:"childConnectionTags" min:"1" type:"list"` + // The ID of an existing connection to migrate to the LAG. ConnectionId *string `locationName:"connectionId" type:"string"` @@ -6642,6 +6801,9 @@ type CreateLagInput struct { // // NumberOfConnections is a required field NumberOfConnections *int64 `locationName:"numberOfConnections" type:"integer" required:"true"` + + // The tags to assign to the link aggregation group (LAG). + Tags []*Tag `locationName:"tags" min:"1" type:"list"` } // String returns the string representation @@ -6657,6 +6819,9 @@ func (s CreateLagInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateLagInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateLagInput"} + if s.ChildConnectionTags != nil && len(s.ChildConnectionTags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChildConnectionTags", 1)) + } if s.ConnectionsBandwidth == nil { invalidParams.Add(request.NewErrParamRequired("ConnectionsBandwidth")) } @@ -6669,6 +6834,29 @@ func (s *CreateLagInput) Validate() error { if s.NumberOfConnections == nil { invalidParams.Add(request.NewErrParamRequired("NumberOfConnections")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.ChildConnectionTags != nil { + for i, v := range s.ChildConnectionTags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ChildConnectionTags", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6676,6 +6864,12 @@ func (s *CreateLagInput) Validate() error { return nil } +// SetChildConnectionTags sets the ChildConnectionTags field's value. +func (s *CreateLagInput) SetChildConnectionTags(v []*Tag) *CreateLagInput { + s.ChildConnectionTags = v + return s +} + // SetConnectionId sets the ConnectionId field's value. func (s *CreateLagInput) SetConnectionId(v string) *CreateLagInput { s.ConnectionId = &v @@ -6706,6 +6900,12 @@ func (s *CreateLagInput) SetNumberOfConnections(v int64) *CreateLagInput { return s } +// SetTags sets the Tags field's value. +func (s *CreateLagInput) SetTags(v []*Tag) *CreateLagInput { + s.Tags = v + return s +} + type CreatePrivateVirtualInterfaceInput struct { _ struct{} `type:"structure"` @@ -6853,6 +7053,11 @@ func (s *CreateTransitVirtualInterfaceInput) Validate() error { if s.NewTransitVirtualInterface == nil { invalidParams.Add(request.NewErrParamRequired("NewTransitVirtualInterface")) } + if s.NewTransitVirtualInterface != nil { + if err := s.NewTransitVirtualInterface.Validate(); err != nil { + invalidParams.AddNested("NewTransitVirtualInterface", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8716,7 +8921,7 @@ type GatewayAttachment struct { // is stopped. AttachmentState *string `locationName:"attachmentState" type:"string" enum:"GatewayAttachmentState"` - // The type of attachment. + // The interface type. AttachmentType *string `locationName:"attachmentType" type:"string" enum:"GatewayAttachmentType"` // The ID of the Direct Connect gateway. @@ -8844,6 +9049,9 @@ type Interconnect struct { // The AWS Region where the connection is located. Region *string `locationName:"region" type:"string"` + + // Any tags assigned to the interconnect. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` } // String returns the string representation @@ -8928,6 +9136,12 @@ func (s *Interconnect) SetRegion(v string) *Interconnect { return s } +// SetTags sets the Tags field's value. +func (s *Interconnect) SetTags(v []*Tag) *Interconnect { + s.Tags = v + return s +} + // Information about a link aggregation group (LAG). type Lag struct { _ struct{} `type:"structure"` @@ -8996,6 +9210,9 @@ type Lag struct { // The AWS Region where the connection is located. Region *string `locationName:"region" type:"string"` + + // Any tags assigned to link aggregation group (LAG). + Tags []*Tag `locationName:"tags" min:"1" type:"list"` } // String returns the string representation @@ -9098,6 +9315,12 @@ func (s *Lag) SetRegion(v string) *Lag { return s } +// SetTags sets the Tags field's value. +func (s *Lag) SetTags(v []*Tag) *Lag { + s.Tags = v + return s +} + // Information about a Letter of Authorization - Connecting Facility Assignment // (LOA-CFA) for a connection. type Loa struct { @@ -9200,7 +9423,8 @@ type NewBGPPeer struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Asn *int64 `locationName:"asn" type:"integer"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The IP address assigned to the customer interface. @@ -9262,7 +9486,8 @@ type NewPrivateVirtualInterface struct { // Asn is a required field Asn *int64 `locationName:"asn" type:"integer" required:"true"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The IP address assigned to the customer interface. @@ -9275,6 +9500,9 @@ type NewPrivateVirtualInterface struct { // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` + // Any tags assigned to the private virtual interface. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The ID of the virtual private gateway. VirtualGatewayId *string `locationName:"virtualGatewayId" deprecated:"true" type:"string"` @@ -9305,12 +9533,25 @@ func (s *NewPrivateVirtualInterface) Validate() error { if s.Asn == nil { invalidParams.Add(request.NewErrParamRequired("Asn")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } if s.VirtualInterfaceName == nil { invalidParams.Add(request.NewErrParamRequired("VirtualInterfaceName")) } if s.Vlan == nil { invalidParams.Add(request.NewErrParamRequired("Vlan")) } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9360,6 +9601,12 @@ func (s *NewPrivateVirtualInterface) SetMtu(v int64) *NewPrivateVirtualInterface return s } +// SetTags sets the Tags field's value. +func (s *NewPrivateVirtualInterface) SetTags(v []*Tag) *NewPrivateVirtualInterface { + s.Tags = v + return s +} + // SetVirtualGatewayId sets the VirtualGatewayId field's value. func (s *NewPrivateVirtualInterface) SetVirtualGatewayId(v string) *NewPrivateVirtualInterface { s.VirtualGatewayId = &v @@ -9393,7 +9640,8 @@ type NewPrivateVirtualInterfaceAllocation struct { // Asn is a required field Asn *int64 `locationName:"asn" type:"integer" required:"true"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The IP address assigned to the customer interface. @@ -9403,6 +9651,10 @@ type NewPrivateVirtualInterfaceAllocation struct { // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` + // Any tags assigned to the private virtual interface to be provisioned on a + // connection. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The name of the virtual interface assigned by the customer network. // // VirtualInterfaceName is a required field @@ -9430,12 +9682,25 @@ func (s *NewPrivateVirtualInterfaceAllocation) Validate() error { if s.Asn == nil { invalidParams.Add(request.NewErrParamRequired("Asn")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } if s.VirtualInterfaceName == nil { invalidParams.Add(request.NewErrParamRequired("VirtualInterfaceName")) } if s.Vlan == nil { invalidParams.Add(request.NewErrParamRequired("Vlan")) } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9479,6 +9744,12 @@ func (s *NewPrivateVirtualInterfaceAllocation) SetMtu(v int64) *NewPrivateVirtua return s } +// SetTags sets the Tags field's value. +func (s *NewPrivateVirtualInterfaceAllocation) SetTags(v []*Tag) *NewPrivateVirtualInterfaceAllocation { + s.Tags = v + return s +} + // SetVirtualInterfaceName sets the VirtualInterfaceName field's value. func (s *NewPrivateVirtualInterfaceAllocation) SetVirtualInterfaceName(v string) *NewPrivateVirtualInterfaceAllocation { s.VirtualInterfaceName = &v @@ -9506,7 +9777,8 @@ type NewPublicVirtualInterface struct { // Asn is a required field Asn *int64 `locationName:"asn" type:"integer" required:"true"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The IP address assigned to the customer interface. @@ -9516,6 +9788,9 @@ type NewPublicVirtualInterface struct { // public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` + // Any tags assigned to the public virtual interface. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The name of the virtual interface assigned by the customer network. // // VirtualInterfaceName is a required field @@ -9543,12 +9818,25 @@ func (s *NewPublicVirtualInterface) Validate() error { if s.Asn == nil { invalidParams.Add(request.NewErrParamRequired("Asn")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } if s.VirtualInterfaceName == nil { invalidParams.Add(request.NewErrParamRequired("VirtualInterfaceName")) } if s.Vlan == nil { invalidParams.Add(request.NewErrParamRequired("Vlan")) } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9592,6 +9880,12 @@ func (s *NewPublicVirtualInterface) SetRouteFilterPrefixes(v []*RouteFilterPrefi return s } +// SetTags sets the Tags field's value. +func (s *NewPublicVirtualInterface) SetTags(v []*Tag) *NewPublicVirtualInterface { + s.Tags = v + return s +} + // SetVirtualInterfaceName sets the VirtualInterfaceName field's value. func (s *NewPublicVirtualInterface) SetVirtualInterfaceName(v string) *NewPublicVirtualInterface { s.VirtualInterfaceName = &v @@ -9619,7 +9913,8 @@ type NewPublicVirtualInterfaceAllocation struct { // Asn is a required field Asn *int64 `locationName:"asn" type:"integer" required:"true"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The IP address assigned to the customer interface. @@ -9629,6 +9924,10 @@ type NewPublicVirtualInterfaceAllocation struct { // public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` + // Any tags assigned to the public virtual interface to be provisioned on a + // connection. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The name of the virtual interface assigned by the customer network. // // VirtualInterfaceName is a required field @@ -9656,12 +9955,25 @@ func (s *NewPublicVirtualInterfaceAllocation) Validate() error { if s.Asn == nil { invalidParams.Add(request.NewErrParamRequired("Asn")) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } if s.VirtualInterfaceName == nil { invalidParams.Add(request.NewErrParamRequired("VirtualInterfaceName")) } if s.Vlan == nil { invalidParams.Add(request.NewErrParamRequired("Vlan")) } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9705,6 +10017,12 @@ func (s *NewPublicVirtualInterfaceAllocation) SetRouteFilterPrefixes(v []*RouteF return s } +// SetTags sets the Tags field's value. +func (s *NewPublicVirtualInterfaceAllocation) SetTags(v []*Tag) *NewPublicVirtualInterfaceAllocation { + s.Tags = v + return s +} + // SetVirtualInterfaceName sets the VirtualInterfaceName field's value. func (s *NewPublicVirtualInterfaceAllocation) SetVirtualInterfaceName(v string) *NewPublicVirtualInterfaceAllocation { s.VirtualInterfaceName = &v @@ -9717,7 +10035,7 @@ func (s *NewPublicVirtualInterfaceAllocation) SetVlan(v int64) *NewPublicVirtual return s } -// Information about a transit virtual interface. +// Information about the transit virtual interface. type NewTransitVirtualInterface struct { _ struct{} `type:"structure"` @@ -9740,9 +10058,12 @@ type NewTransitVirtualInterface struct { DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` // The maximum transmission unit (MTU), in bytes. The supported values are 1500 - // and 9001. The default value is 1500. + // and 8500. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` + // Any tags assigned to the transit virtual interface. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The name of the virtual interface assigned by the customer network. VirtualInterfaceName *string `locationName:"virtualInterfaceName" type:"string"` @@ -9760,6 +10081,29 @@ func (s NewTransitVirtualInterface) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *NewTransitVirtualInterface) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "NewTransitVirtualInterface"} + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAddressFamily sets the AddressFamily field's value. func (s *NewTransitVirtualInterface) SetAddressFamily(v string) *NewTransitVirtualInterface { s.AddressFamily = &v @@ -9802,6 +10146,12 @@ func (s *NewTransitVirtualInterface) SetMtu(v int64) *NewTransitVirtualInterface return s } +// SetTags sets the Tags field's value. +func (s *NewTransitVirtualInterface) SetTags(v []*Tag) *NewTransitVirtualInterface { + s.Tags = v + return s +} + // SetVirtualInterfaceName sets the VirtualInterfaceName field's value. func (s *NewTransitVirtualInterface) SetVirtualInterfaceName(v string) *NewTransitVirtualInterface { s.VirtualInterfaceName = &v @@ -9814,7 +10164,7 @@ func (s *NewTransitVirtualInterface) SetVlan(v int64) *NewTransitVirtualInterfac return s } -// Information about a transit virtual interface to be provisioned on a connection. +// Information about a transit virtual interface. type NewTransitVirtualInterfaceAllocation struct { _ struct{} `type:"structure"` @@ -9834,9 +10184,12 @@ type NewTransitVirtualInterfaceAllocation struct { CustomerAddress *string `locationName:"customerAddress" type:"string"` // The maximum transmission unit (MTU), in bytes. The supported values are 1500 - // and 9001. The default value is 1500. + // and 8500. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` + // Any tags assigned to the transit virtual interface. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The name of the virtual interface assigned by the customer network. VirtualInterfaceName *string `locationName:"virtualInterfaceName" type:"string"` @@ -9854,6 +10207,29 @@ func (s NewTransitVirtualInterfaceAllocation) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *NewTransitVirtualInterfaceAllocation) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "NewTransitVirtualInterfaceAllocation"} + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAddressFamily sets the AddressFamily field's value. func (s *NewTransitVirtualInterfaceAllocation) SetAddressFamily(v string) *NewTransitVirtualInterfaceAllocation { s.AddressFamily = &v @@ -9890,6 +10266,12 @@ func (s *NewTransitVirtualInterfaceAllocation) SetMtu(v int64) *NewTransitVirtua return s } +// SetTags sets the Tags field's value. +func (s *NewTransitVirtualInterfaceAllocation) SetTags(v []*Tag) *NewTransitVirtualInterfaceAllocation { + s.Tags = v + return s +} + // SetVirtualInterfaceName sets the VirtualInterfaceName field's value. func (s *NewTransitVirtualInterfaceAllocation) SetVirtualInterfaceName(v string) *NewTransitVirtualInterfaceAllocation { s.VirtualInterfaceName = &v @@ -10020,7 +10402,7 @@ type TagResourceInput struct { // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` - // The tags to add. + // The tags to assign. // // Tags is a required field Tags []*Tag `locationName:"tags" min:"1" type:"list" required:"true"` @@ -10343,7 +10725,8 @@ type UpdateVirtualInterfaceAttributesOutput struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Asn *int64 `locationName:"asn" type:"integer"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The Direct Connect endpoint on which the virtual interface terminates. @@ -10384,6 +10767,9 @@ type UpdateVirtualInterfaceAttributesOutput struct { // public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` + // Any tags assigned to the virtual interface. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The ID of the virtual private gateway. Applies only to private virtual interfaces. VirtualGatewayId *string `locationName:"virtualGatewayId" deprecated:"true" type:"string"` @@ -10544,6 +10930,12 @@ func (s *UpdateVirtualInterfaceAttributesOutput) SetRouteFilterPrefixes(v []*Rou return s } +// SetTags sets the Tags field's value. +func (s *UpdateVirtualInterfaceAttributesOutput) SetTags(v []*Tag) *UpdateVirtualInterfaceAttributesOutput { + s.Tags = v + return s +} + // SetVirtualGatewayId sets the VirtualGatewayId field's value. func (s *UpdateVirtualInterfaceAttributesOutput) SetVirtualGatewayId(v string) *UpdateVirtualInterfaceAttributesOutput { s.VirtualGatewayId = &v @@ -10639,7 +11031,8 @@ type VirtualInterface struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Asn *int64 `locationName:"asn" type:"integer"` - // The authentication key for BGP configuration. + // The authentication key for BGP configuration. This string has a minimum length + // of 6 characters and and a maximun lenth of 80 characters. AuthKey *string `locationName:"authKey" type:"string"` // The Direct Connect endpoint on which the virtual interface terminates. @@ -10680,6 +11073,9 @@ type VirtualInterface struct { // public virtual interfaces. RouteFilterPrefixes []*RouteFilterPrefix `locationName:"routeFilterPrefixes" type:"list"` + // Any tags assigned to the virtual interface. + Tags []*Tag `locationName:"tags" min:"1" type:"list"` + // The ID of the virtual private gateway. Applies only to private virtual interfaces. VirtualGatewayId *string `locationName:"virtualGatewayId" deprecated:"true" type:"string"` @@ -10840,6 +11236,12 @@ func (s *VirtualInterface) SetRouteFilterPrefixes(v []*RouteFilterPrefix) *Virtu return s } +// SetTags sets the Tags field's value. +func (s *VirtualInterface) SetTags(v []*Tag) *VirtualInterface { + s.Tags = v + return s +} + // SetVirtualGatewayId sets the VirtualGatewayId field's value. func (s *VirtualInterface) SetVirtualGatewayId(v string) *VirtualInterface { s.VirtualGatewayId = &v diff --git a/vendor/github.com/aws/aws-sdk-go/service/dynamodb/api.go b/vendor/github.com/aws/aws-sdk-go/service/dynamodb/api.go index f169423c230..8c889ff3455 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/dynamodb/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/dynamodb/api.go @@ -90,23 +90,23 @@ func (c *DynamoDB) BatchGetItemRequest(input *BatchGetItemInput) (req *request.R // one or more tables. You identify requested items by primary key. // // A single operation can retrieve up to 16 MB of data, which can contain as -// many as 100 items. BatchGetItem will return a partial result if the response +// many as 100 items. BatchGetItem returns a partial result if the response // size limit is exceeded, the table's provisioned throughput is exceeded, or // an internal processing failure occurs. If a partial result is returned, the // operation returns a value for UnprocessedKeys. You can use this value to // retry the operation starting with the next item to get. // -// If you request more than 100 items BatchGetItem will return a ValidationException -// with the message "Too many items requested for the BatchGetItem call". +// If you request more than 100 items, BatchGetItem returns a ValidationException +// with the message "Too many items requested for the BatchGetItem call." // // For example, if you ask to retrieve 100 items, but each individual item is // 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB // limit). It also returns an appropriate UnprocessedKeys value so you can get // the next page of results. If desired, your application can include its own -// logic to assemble the pages of results into one data set. +// logic to assemble the pages of results into one dataset. // // If none of the items can be processed due to insufficient provisioned throughput -// on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. +// on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. // If at least one of the items is successfully processed, then BatchGetItem // completes successfully, while returning the keys of the unread items in UnprocessedKeys. // @@ -133,7 +133,7 @@ func (c *DynamoDB) BatchGetItemRequest(input *BatchGetItemInput) (req *request.R // // If a requested item does not exist, it is not returned in the result. Requests // for nonexistent items consume the minimum read capacity units according to -// the type of read. For more information, see Capacity Units Calculations (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) +// the type of read. For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) // in the Amazon DynamoDB Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -317,9 +317,8 @@ func (c *DynamoDB) BatchWriteItemRequest(input *BatchWriteItemInput) (req *reque // check for unprocessed items and submit a new BatchWriteItem request with // those unprocessed items until all items have been processed. // -// Note that if none of the items can be processed due to insufficient provisioned -// throughput on all of the tables in the request, then BatchWriteItem will -// return a ProvisionedThroughputExceededException. +// If none of the items can be processed due to insufficient provisioned throughput +// on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. // // If DynamoDB returns any unprocessed items, you should retry the batch operation // on those items. However, we strongly recommend that you use an exponential @@ -328,16 +327,15 @@ func (c *DynamoDB) BatchWriteItemRequest(input *BatchWriteItemInput) (req *reque // tables. If you delay the batch operation using exponential backoff, the individual // requests in the batch are much more likely to succeed. // -// For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations) +// For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations) // in the Amazon DynamoDB Developer Guide. // // With BatchWriteItem, you can efficiently write or delete large amounts of -// data, such as from Amazon Elastic MapReduce (EMR), or copy data from another -// database into DynamoDB. In order to improve performance with these large-scale -// operations, BatchWriteItem does not behave in the same way as individual -// PutItem and DeleteItem calls would. For example, you cannot specify conditions -// on individual put and delete requests, and BatchWriteItem does not return -// deleted items in the response. +// data, such as from Amazon EMR, or copy data from another database into DynamoDB. +// In order to improve performance with these large-scale operations, BatchWriteItem +// does not behave in the same way as individual PutItem and DeleteItem calls +// would. For example, you cannot specify conditions on individual put and delete +// requests, and BatchWriteItem does not return deleted items in the response. // // If you use a programming language that supports concurrency, you can use // threads to write items in parallel. Your application must include the necessary @@ -495,10 +493,10 @@ func (c *DynamoDB) CreateBackupRequest(input *CreateBackupInput) (req *request.R // // Creates a backup for an existing table. // -// Each time you create an On-Demand Backup, the entire table data is backed +// Each time you create an on-demand backup, the entire table data is backed // up. There is no limit to the number of on-demand backups that can be taken. // -// When you create an On-Demand Backup, a time marker of the request is cataloged, +// When you create an on-demand backup, a time marker of the request is cataloged, // and the backup is created asynchronously, by applying all changes until the // time of the request to the last full table snapshot. Backup requests are // processed instantaneously and become available for restore within minutes. @@ -510,9 +508,8 @@ func (c *DynamoDB) CreateBackupRequest(input *CreateBackupInput) (req *request.R // // If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed // to contain all data committed to the table up to 14:24:00, and data committed -// after 14:26:00 will not be. The backup may or may not contain data modifications -// made between 14:24:00 and 14:26:00. On-Demand Backup does not support causal -// consistency. +// after 14:26:00 will not be. The backup might contain data modifications made +// between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency. // // Along with data, the following are also included on the backups: // @@ -652,7 +649,7 @@ func (c *DynamoDB) CreateGlobalTableRequest(input *CreateGlobalTableInput) (req // // Creates a global table from an existing table. A global table creates a replication // relationship between two or more DynamoDB tables with the same table name -// in the provided regions. +// in the provided Regions. // // If you want to add a new replica table to a global table, each of the following // conditions must be true: @@ -804,8 +801,8 @@ func (c *DynamoDB) CreateTableRequest(input *CreateTableInput) (req *request.Req // CreateTable API operation for Amazon DynamoDB. // // The CreateTable operation adds a new table to your account. In an AWS account, -// table names must be unique within each region. That is, you can have two -// tables with same name if you create the tables in different regions. +// table names must be unique within each Region. That is, you can have two +// tables with same name if you create the tables in different Regions. // // CreateTable is an asynchronous operation. Upon receiving a CreateTable request, // DynamoDB immediately returns a response with a TableStatus of CREATING. After @@ -1449,8 +1446,8 @@ func (c *DynamoDB) DescribeContinuousBackupsRequest(input *DescribeContinuousBac // If point in time recovery is enabled, PointInTimeRecoveryStatus will be set // to ENABLED. // -// Once continuous backups and point in time recovery are enabled, you can restore -// to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. +// After continuous backups and point in time recovery are enabled, you can +// restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. // // LatestRestorableDateTime is typically 5 minutes before the current time. // You can restore your table to any point in time during the last 35 days. @@ -1796,7 +1793,7 @@ func (c *DynamoDB) DescribeGlobalTableSettingsRequest(input *DescribeGlobalTable // DescribeGlobalTableSettings API operation for Amazon DynamoDB. // -// Describes region specific settings for a global table. +// Describes Region-specific settings for a global table. // // 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 @@ -1900,12 +1897,12 @@ func (c *DynamoDB) DescribeLimitsRequest(input *DescribeLimitsInput) (req *reque // DescribeLimits API operation for Amazon DynamoDB. // // Returns the current provisioned-capacity limits for your AWS account in a -// region, both for the region as a whole and for any one DynamoDB table that +// Region, both for the Region as a whole and for any one DynamoDB table that // you create there. // // When you establish an AWS account, the account has initial limits on the // maximum read capacity units and write capacity units that you can provision -// across all of your DynamoDB tables in a given region. Also, there are per-table +// across all of your DynamoDB tables in a given Region. Also, there are per-table // limits that apply when you create a table there. For more information, see // Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // page in the Amazon DynamoDB Developer Guide. @@ -1918,11 +1915,11 @@ func (c *DynamoDB) DescribeLimitsRequest(input *DescribeLimitsInput) (req *reque // // For example, you could use one of the AWS SDKs to do the following: // -// Call DescribeLimits for a particular region to obtain your current account +// Call DescribeLimits for a particular Region to obtain your current account // limits on provisioned capacity there. // // Create a variable to hold the aggregate read capacity units provisioned for -// all your tables in that region, and one to hold the aggregate write capacity +// all your tables in that Region, and one to hold the aggregate write capacity // units. Zero them both. // // Call ListTables to obtain a list of all your DynamoDB tables. @@ -1938,7 +1935,7 @@ func (c *DynamoDB) DescribeLimitsRequest(input *DescribeLimitsInput) (req *reque // these GSIs and add their provisioned capacity values to your variables // as well. // -// Report the account limits for that region returned by DescribeLimits, along +// Report the account limits for that Region returned by DescribeLimits, along // with the total current provisioned capacity levels you have calculated. // // This will let you see whether you are getting close to your account-level @@ -1948,8 +1945,8 @@ func (c *DynamoDB) DescribeLimitsRequest(input *DescribeLimitsInput) (req *reque // the sum of the provisioned capacity of the new table itself and all its global // secondary indexes. // -// For existing tables and their GSIs, DynamoDB will not let you increase provisioned -// capacity extremely rapidly, but the only upper limit that applies is that +// For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned +// capacity extremely rapidly. But the only upper limit that applies is that // the aggregate provisioned capacity over all your tables and GSIs cannot exceed // either of the per-account limits. // @@ -2398,13 +2395,13 @@ func (c *DynamoDB) ListBackupsRequest(input *ListBackupsInput) (req *request.Req // // List backups associated with an AWS account. To list backups for a given // table, specify TableName. ListBackups returns a paginated list of results -// with at most 1MB worth of items in a page. You can also specify a limit for -// the maximum number of entries to be returned in a page. +// with at most 1 MB worth of items in a page. You can also specify a limit +// for the maximum number of entries to be returned in a page. // -// In the request, start time is inclusive but end time is exclusive. Note that -// these limits are for the time at which the original backup was requested. +// In the request, start time is inclusive, but end time is exclusive. Note +// that these limits are for the time at which the original backup was requested. // -// You can call ListBackups a maximum of 5 times per second. +// You can call ListBackups a maximum of five times per second. // // 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 @@ -2504,7 +2501,7 @@ func (c *DynamoDB) ListGlobalTablesRequest(input *ListGlobalTablesInput) (req *r // ListGlobalTables API operation for Amazon DynamoDB. // -// Lists all global tables that have a replica in the specified region. +// Lists all global tables that have a replica in the specified Region. // // 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 @@ -2901,10 +2898,10 @@ func (c *DynamoDB) PutItemRequest(input *PutItemInput) (req *request.Request, ou // // * PutItem in the AWS SDK for Ruby V2 (http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem) // -// When you add an item, the primary key attribute(s) are the only required -// attributes. Attribute values cannot be null. String and Binary type attributes -// must have lengths greater than zero. Set type attributes cannot be empty. -// Requests with empty values will be rejected with a ValidationException exception. +// When you add an item, the primary key attributes are the only required attributes. +// Attribute values cannot be null. String and Binary type attributes must have +// lengths greater than zero. Set type attributes cannot be empty. Requests +// with empty values will be rejected with a ValidationException exception. // // To prevent a new item from replacing an existing item, use a conditional // expression that contains the attribute_not_exists function with the name @@ -3271,7 +3268,7 @@ func (c *DynamoDB) RestoreTableFromBackupRequest(input *RestoreTableFromBackupIn // // * IAM policies // -// * Cloudwatch metrics and alarms +// * Amazon CloudWatch metrics and alarms // // * Tags // @@ -3431,7 +3428,7 @@ func (c *DynamoDB) RestoreTableToPointInTimeRequest(input *RestoreTableToPointIn // // * IAM policies // -// * Cloudwatch metrics and alarms +// * Amazon CloudWatch metrics and alarms // // * Tags // @@ -3580,16 +3577,16 @@ func (c *DynamoDB) ScanRequest(input *ScanInput) (req *request.Request, output * // every item in a table or a secondary index. To have DynamoDB return fewer // items, you can provide a FilterExpression operation. // -// If the total number of scanned items exceeds the maximum data set size limit +// If the total number of scanned items exceeds the maximum dataset size limit // of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey // value to continue the scan in a subsequent operation. The results also include // the number of items exceeding the limit. A scan can result in no table data // meeting the filter criteria. // -// A single Scan operation will read up to the maximum number of items set (if -// using the Limit parameter) or a maximum of 1 MB of data and then apply any -// filtering to the results using FilterExpression. If LastEvaluatedKey is present -// in the response, you will need to paginate the result set. For more information, +// A single Scan operation reads up to the maximum number of items set (if using +// the Limit parameter) or a maximum of 1 MB of data and then apply any filtering +// to the results using FilterExpression. If LastEvaluatedKey is present in +// the response, you need to paginate the result set. For more information, // see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination) // in the Amazon DynamoDB Developer Guide. // @@ -3773,8 +3770,8 @@ func (c *DynamoDB) TagResourceRequest(input *TagResourceInput) (req *request.Req // // Associate a set of tags with an Amazon DynamoDB resource. You can then activate // these user-defined tags so that they appear on the Billing and Cost Management -// console for cost allocation tracking. You can call TagResource up to 5 times -// per second, per account. +// console for cost allocation tracking. You can call TagResource up to five +// times per second, per account. // // For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) // in the Amazon DynamoDB Developer Guide. @@ -3902,10 +3899,21 @@ func (c *DynamoDB) TransactGetItemsRequest(input *TransactGetItemsInput) (req *r // // TransactGetItems is a synchronous operation that atomically retrieves multiple // items from one or more tables (but not from indexes) in a single account -// and region. A TransactGetItems call can contain up to 10 TransactGetItem +// and Region. A TransactGetItems call can contain up to 25 TransactGetItem // objects, each of which contains a Get structure that specifies an item to -// retrieve from a table in the account and region. A call to TransactGetItems -// cannot retrieve items from tables in more than one AWS account or region. +// retrieve from a table in the account and Region. A call to TransactGetItems +// cannot retrieve items from tables in more than one AWS account or Region. +// The aggregate size of the items in the transaction cannot exceed 4 MB. +// +// All AWS Regions and AWS GovCloud (US) support up to 25 items per transaction +// with up to 4 MB of data, except the following AWS Regions: +// +// * China (Beijing) +// +// * China (Ningxia) +// +// The China (Beijing) and China (Ningxia) Regions support up to 10 items per +// transaction with up to 4 MB of data. // // DynamoDB rejects the entire TransactGetItems request if any of the following // is true: @@ -3918,6 +3926,8 @@ func (c *DynamoDB) TransactGetItemsRequest(input *TransactGetItemsInput) (req *r // // * There is a user error, such as an invalid data format. // +// * The aggregate size of the items in the transaction cannot exceed 4 MB. +// // 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. @@ -3950,6 +3960,8 @@ func (c *DynamoDB) TransactGetItemsRequest(input *TransactGetItemsInput) (req *r // index (LSI) becomes too large, or a similar validation error occurs because // of changes made by the transaction. // +// * The aggregate size of the items in the transaction exceeds 4 MBs. +// // * There is a user error, such as an invalid data format. // // DynamoDB cancels a TransactGetItems request under the following circumstances: @@ -3964,6 +3976,8 @@ func (c *DynamoDB) TransactGetItemsRequest(input *TransactGetItemsInput) (req *r // * There is insufficient provisioned capacity for the transaction to be // completed. // +// * The aggregate size of the items in the transaction exceeds 4 MBs. +// // * There is a user error, such as an invalid data format. // // If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons @@ -4115,11 +4129,22 @@ func (c *DynamoDB) TransactWriteItemsRequest(input *TransactWriteItemsInput) (re // TransactWriteItems API operation for Amazon DynamoDB. // -// TransactWriteItems is a synchronous write operation that groups up to 10 +// TransactWriteItems is a synchronous write operation that groups up to 25 // action requests. These actions can target items in different tables, but -// not in different AWS accounts or regions, and no two actions can target the +// not in different AWS accounts or Regions, and no two actions can target the // same item. For example, you cannot both ConditionCheck and Update the same -// item. +// item. The aggregate size of the items in the transaction cannot exceed 4 +// MB. +// +// All AWS Regions and AWS GovCloud (US) support up to 25 items per transaction +// with up to 4 MB of data, except the following AWS Regions: +// +// * China (Beijing) +// +// * China (Ningxia) +// +// The China (Beijing) and China (Ningxia) Regions support up to 10 items per +// transaction with up to 4 MB of data. // // The actions are completed atomically so that either all of them succeed, // or all of them fail. They are defined by the following objects: @@ -4128,44 +4153,45 @@ func (c *DynamoDB) TransactWriteItemsRequest(input *TransactWriteItemsInput) (re // specifies the primary key of the item to be written, the name of the table // to write it in, an optional condition expression that must be satisfied // for the write to succeed, a list of the item's attributes, and a field -// indicating whether or not to retrieve the item's attributes if the condition +// indicating whether to retrieve the item's attributes if the condition // is not met. // // * Update — Initiates an UpdateItem operation to update an existing item. // This structure specifies the primary key of the item to be updated, the // name of the table where it resides, an optional condition expression that // must be satisfied for the update to succeed, an expression that defines -// one or more attributes to be updated, and a field indicating whether or -// not to retrieve the item's attributes if the condition is not met. +// one or more attributes to be updated, and a field indicating whether to +// retrieve the item's attributes if the condition is not met. // // * Delete — Initiates a DeleteItem operation to delete an existing item. // This structure specifies the primary key of the item to be deleted, the // name of the table where it resides, an optional condition expression that // must be satisfied for the deletion to succeed, and a field indicating -// whether or not to retrieve the item's attributes if the condition is not -// met. +// whether to retrieve the item's attributes if the condition is not met. // // * ConditionCheck — Applies a condition to an item that is not being // modified by the transaction. This structure specifies the primary key // of the item to be checked, the name of the table where it resides, a condition // expression that must be satisfied for the transaction to succeed, and -// a field indicating whether or not to retrieve the item's attributes if -// the condition is not met. +// a field indicating whether to retrieve the item's attributes if the condition +// is not met. // // DynamoDB rejects the entire TransactWriteItems request if any of the following // is true: // // * A condition in one of the condition expressions is not met. // -// * A conflicting operation is in the process of updating the same item. +// * An ongoing operation is in the process of updating the same item. // // * There is insufficient provisioned capacity for the transaction to be // completed. // -// * An item size becomes too large (bigger than 400 KB), a Local Secondary -// Index (LSI) becomes too large, or a similar validation error occurs because +// * An item size becomes too large (bigger than 400 KB), a local secondary +// index (LSI) becomes too large, or a similar validation error occurs because // of changes made by the transaction. // +// * The aggregate size of the items in the transaction exceeds 4 MB. +// // * There is a user error, such as an invalid data format. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4200,6 +4226,8 @@ func (c *DynamoDB) TransactWriteItemsRequest(input *TransactWriteItemsInput) (re // index (LSI) becomes too large, or a similar validation error occurs because // of changes made by the transaction. // +// * The aggregate size of the items in the transaction exceeds 4 MBs. +// // * There is a user error, such as an invalid data format. // // DynamoDB cancels a TransactGetItems request under the following circumstances: @@ -4214,6 +4242,8 @@ func (c *DynamoDB) TransactWriteItemsRequest(input *TransactWriteItemsInput) (re // * There is insufficient provisioned capacity for the transaction to be // completed. // +// * The aggregate size of the items in the transaction exceeds 4 MBs. +// // * There is a user error, such as an invalid data format. // // If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons @@ -4374,7 +4404,7 @@ func (c *DynamoDB) UntagResourceRequest(input *UntagResourceInput) (req *request // UntagResource API operation for Amazon DynamoDB. // // Removes the association of tags from an Amazon DynamoDB resource. You can -// call UntagResource up to 5 times per second, per account. +// call UntagResource up to five times per second, per account. // // For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) // in the Amazon DynamoDB Developer Guide. @@ -4510,7 +4540,7 @@ func (c *DynamoDB) UpdateContinuousBackupsRequest(input *UpdateContinuousBackups // to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. // // LatestRestorableDateTime is typically 5 minutes before the current time. -// You can restore your table to any point in time during the last 35 days.. +// You can restore your table to any point in time during the last 35 days. // // 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 @@ -4619,9 +4649,9 @@ func (c *DynamoDB) UpdateGlobalTableRequest(input *UpdateGlobalTableInput) (req // // Adds or removes replicas in the specified global table. The global table // must already exist to be able to use this operation. Any replica to be added -// must be empty, must have the same name as the global table, must have the -// same key schema, and must have DynamoDB Streams enabled and must have same -// provisioned and maximum write capacity units. +// must be empty, have the same name as the global table, have the same key +// schema, have DynamoDB Streams enabled, and have the same provisioned and +// maximum write capacity units. // // Although you can use UpdateGlobalTable to add replicas and remove replicas // in a single request, for simplicity we recommend that you issue separate @@ -5018,11 +5048,11 @@ func (c *DynamoDB) UpdateTableRequest(input *UpdateTableInput) (req *request.Req // // * Modify the provisioned throughput settings of the table. // -// * Enable or disable Streams on the table. +// * Enable or disable DynamoDB Streams on the table. // // * Remove a global secondary index from the table. // -// * Create a new global secondary index on the table. Once the index begins +// * Create a new global secondary index on the table. After the index begins // backfilling, you can use UpdateTable to perform other operations. // // UpdateTable is an asynchronous operation; while it is executing, the table @@ -5151,9 +5181,9 @@ func (c *DynamoDB) UpdateTimeToLiveRequest(input *UpdateTimeToLiveInput) (req *r // UpdateTimeToLive API operation for Amazon DynamoDB. // -// The UpdateTimeToLive method will enable or disable TTL for the specified -// table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification; -// it may take up to one hour for the change to fully process. Any additional +// The UpdateTimeToLive method enables or disables Time to Live (TTL) for the +// specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. +// It can take up to one hour for the change to fully process. Any additional // UpdateTimeToLive calls for the same table during this one hour duration result // in a ValidationException. // @@ -5163,7 +5193,7 @@ func (c *DynamoDB) UpdateTimeToLiveRequest(input *UpdateTimeToLiveInput) (req *r // deleted. // // The epoch time format is the number of seconds elapsed since 12:00:00 AM -// January 1st, 1970 UTC. +// January 1, 1970 UTC. // // DynamoDB deletes expired items on a best-effort basis to ensure availability // of throughput for other data operations. @@ -5173,8 +5203,8 @@ func (c *DynamoDB) UpdateTimeToLiveRequest(input *UpdateTimeToLiveInput) (req *r // to the nature of the workload. Items that have expired and not been deleted // will still show up in reads, queries, and scans. // -// As items are deleted, they are removed from any Local Secondary Index and -// Global Secondary Index immediately in the same eventually consistent way +// As items are deleted, they are removed from any local secondary index and +// global secondary index immediately in the same eventually consistent way // as a standard delete operation. // // For more information, see Time To Live (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) @@ -6213,7 +6243,7 @@ type BatchGetItemInput struct { // You could then use this substitution in an expression, as in this example: // #P = :val Tokens that begin with the : character are expression attribute // values, which are placeholders for the actual value at runtime. For more - // information on expression attribute names, see Accessing Item Attributes + // information about expression attribute names, see Accessing Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. // @@ -6227,8 +6257,8 @@ type BatchGetItemInput struct { // to retrieve from the table. These attributes can include scalars, sets, // or elements of a JSON document. The attributes in the expression must // be separated by commas. If no attribute names are specified, then all - // attributes will be returned. If any of the requested attributes are not - // found, they will not appear in the result. For more information, see Accessing + // attributes are returned. If any of the requested attributes are not found, + // they do not appear in the result. For more information, see Accessing // Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. // @@ -6394,10 +6424,10 @@ type BatchWriteItemInput struct { // and their values. Each entry in this map consists of an attribute name // and an attribute value. Attribute values must not be null; string and // binary type attributes must have lengths greater than zero; and set type - // attributes must not be empty. Requests that contain empty values will - // be rejected with a ValidationException exception. If you specify any attributes - // that are part of an index key, then the data types for those attributes - // must match those of the schema in the table's attribute definition. + // attributes must not be empty. Requests that contain empty values are rejected + // with a ValidationException exception. If you specify any attributes that + // are part of an index key, then the data types for those attributes must + // match those of the schema in the table's attribute definition. // // RequestItems is a required field RequestItems map[string][]*WriteRequest `min:"1" type:"map" required:"true"` @@ -7284,7 +7314,7 @@ type CreateGlobalTableInput struct { // GlobalTableName is a required field GlobalTableName *string `min:"3" type:"string" required:"true"` - // The regions where the global table needs to be created. + // The Regions where the global table needs to be created. // // ReplicationGroup is a required field ReplicationGroup []*Replica `type:"list" required:"true"` @@ -7426,7 +7456,7 @@ type CreateTableInput struct { // specification is composed of: ProjectionType - One of the following: KEYS_ONLY // - Only the index and primary keys are projected into the index. INCLUDE // - Only the specified table attributes are projected into the index. The - // list of projected attributes are in NonKeyAttributes. ALL - All of the + // list of projected attributes is in NonKeyAttributes. ALL - All of the // table attributes are projected into the index. NonKeyAttributes - A list // of one or more non-key attribute names that are projected into the secondary // index. The total count of attributes provided in NonKeyAttributes, summed @@ -7451,7 +7481,7 @@ type CreateTableInput struct { // key RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term - // "hash attribute" derives from DynamoDB' usage of an internal hash function + // "hash attribute" derives from the DynamoDB usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // @@ -7466,7 +7496,7 @@ type CreateTableInput struct { // exactly two elements, in this order: The first element must have a KeyType // of HASH, and the second element must have a KeyType of RANGE. // - // For more information, see Specifying the Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key) + // For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key) // in the Amazon DynamoDB Developer Guide. // // KeySchema is a required field @@ -7491,7 +7521,7 @@ type CreateTableInput struct { // specification is composed of: ProjectionType - One of the following: KEYS_ONLY // - Only the index and primary keys are projected into the index. INCLUDE // - Only the specified table attributes are projected into the index. The - // list of projected attributes are in NonKeyAttributes. ALL - All of the + // list of projected attributes is in NonKeyAttributes. ALL - All of the // table attributes are projected into the index. NonKeyAttributes - A list // of one or more non-key attribute names that are projected into the secondary // index. The total count of attributes provided in NonKeyAttributes, summed @@ -7516,8 +7546,8 @@ type CreateTableInput struct { // The settings for DynamoDB Streams on the table. These settings consist of: // - // * StreamEnabled - Indicates whether Streams is to be enabled (true) or - // disabled (false). + // * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled + // (true) or disabled (false). // // * StreamViewType - When an item in the table is modified, StreamViewType // determines what information is written to the table's stream. Valid values @@ -7930,7 +7960,7 @@ type DeleteItemInput struct { // // * Logical operators: AND | OR | NOT // - // For more information on condition expressions, see Specifying Conditions + // For more information about condition expressions, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ConditionExpression *string `type:"string"` @@ -7977,7 +8007,7 @@ type DeleteItemInput struct { // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // - // For more information on expression attribute names, see Accessing Item Attributes + // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` @@ -7999,7 +8029,7 @@ type DeleteItemInput struct { // // ProductStatus IN (:avail, :back, :disc) // - // For more information on expression attribute values, see Specifying Conditions + // For more information on expression attribute values, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` @@ -8156,7 +8186,7 @@ type DeleteItemOutput struct { // includes the total provisioned throughput consumed, along with statistics // for the table and any indexes involved in the operation. ConsumedCapacity // is only returned if the ReturnConsumedCapacity parameter was specified. For - // more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // more information, see Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` @@ -8345,7 +8375,7 @@ func (s *DeleteTableOutput) SetTableDescription(v *TableDescription) *DeleteTabl type DescribeBackupInput struct { _ struct{} `type:"structure"` - // The ARN associated with the backup. + // The Amazon Resource Name (ARN) associated with the backup. // // BackupArn is a required field BackupArn *string `min:"37" type:"string" required:"true"` @@ -8622,7 +8652,7 @@ type DescribeGlobalTableSettingsOutput struct { // The name of the global table. GlobalTableName *string `min:"3" type:"string"` - // The region specific settings for the global table. + // The Region-specific settings for the global table. ReplicaSettings []*ReplicaSettingsDescription `type:"list"` } @@ -8668,20 +8698,20 @@ type DescribeLimitsOutput struct { _ struct{} `type:"structure"` // The maximum total read capacity units that your account allows you to provision - // across all of your tables in this region. + // across all of your tables in this Region. AccountMaxReadCapacityUnits *int64 `min:"1" type:"long"` // The maximum total write capacity units that your account allows you to provision - // across all of your tables in this region. + // across all of your tables in this Region. AccountMaxWriteCapacityUnits *int64 `min:"1" type:"long"` // The maximum read capacity units that your account allows you to provision - // for a new table that you are creating in this region, including the read + // for a new table that you are creating in this Region, including the read // capacity units provisioned for its global secondary indexes (GSIs). TableMaxReadCapacityUnits *int64 `min:"1" type:"long"` // The maximum write capacity units that your account allows you to provision - // for a new table that you are creating in this region, including the write + // for a new table that you are creating in this Region, including the write // capacity units provisioned for its global secondary indexes (GSIs). TableMaxWriteCapacityUnits *int64 `min:"1" type:"long"` } @@ -9234,7 +9264,7 @@ type GetItemInput struct { // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // - // For more information on expression attribute names, see Accessing Item Attributes + // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` @@ -9254,11 +9284,11 @@ type GetItemInput struct { // These attributes can include scalars, sets, or elements of a JSON document. // The attributes in the expression must be separated by commas. // - // If no attribute names are specified, then all attributes will be returned. - // If any of the requested attributes are not found, they will not appear in - // the result. + // If no attribute names are specified, then all attributes are returned. If + // any of the requested attributes are not found, they do not appear in the + // result. // - // For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string `type:"string"` @@ -9365,7 +9395,7 @@ type GetItemOutput struct { // the total provisioned throughput consumed, along with statistics for the // table and any indexes involved in the operation. ConsumedCapacity is only // returned if the ReturnConsumedCapacity parameter was specified. For more - // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` @@ -10279,10 +10309,10 @@ type ListBackupsInput struct { // * ALL - All types of on-demand backups (USER and SYSTEM). BackupType *string `type:"string" enum:"BackupTypeFilter"` - // LastEvaluatedBackupArn is the ARN of the backup last evaluated when the current - // page of results was returned, inclusive of the current page of results. This - // value may be specified as the ExclusiveStartBackupArn of a new ListBackups - // operation in order to fetch the next page of results. + // LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last + // evaluated when the current page of results was returned, inclusive of the + // current page of results. This value may be specified as the ExclusiveStartBackupArn + // of a new ListBackups operation in order to fetch the next page of results. ExclusiveStartBackupArn *string `min:"37" type:"string"` // Maximum number of backups to return at once. @@ -10378,9 +10408,9 @@ type ListBackupsOutput struct { // If LastEvaluatedBackupArn is empty, then the last page of results has been // processed and there are no more results to be retrieved. // - // If LastEvaluatedBackupArn is not empty, this may or may not indicate there - // is more data to be returned. All results are guaranteed to have been returned - // if and only if no value for LastEvaluatedBackupArn is returned. + // If LastEvaluatedBackupArn is not empty, this may or may not indicate that + // there is more data to be returned. All results are guaranteed to have been + // returned if and only if no value for LastEvaluatedBackupArn is returned. LastEvaluatedBackupArn *string `min:"37" type:"string"` } @@ -10415,7 +10445,7 @@ type ListGlobalTablesInput struct { // The maximum number of table names to return. Limit *int64 `min:"1" type:"integer"` - // Lists the global tables in a specific region. + // Lists the global tables in a specific Region. RegionName *string `type:"string"` } @@ -11334,7 +11364,7 @@ type PutItemInput struct { // // * Logical operators: AND | OR | NOT // - // For more information on condition expressions, see Specifying Conditions + // For more information on condition expressions, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ConditionExpression *string `type:"string"` @@ -11381,7 +11411,7 @@ type PutItemInput struct { // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // - // For more information on expression attribute names, see Accessing Item Attributes + // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` @@ -11403,7 +11433,7 @@ type PutItemInput struct { // // ProductStatus IN (:avail, :back, :disc) // - // For more information on expression attribute values, see Specifying Conditions + // For more information on expression attribute values, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` @@ -11421,7 +11451,7 @@ type PutItemInput struct { // types for those attributes must match those of the schema in the table's // attribute definition. // - // For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey) + // For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey) // in the Amazon DynamoDB Developer Guide. // // Each element in the Item map is an AttributeValue object. @@ -11572,7 +11602,7 @@ type PutItemOutput struct { // the total provisioned throughput consumed, along with statistics for the // table and any indexes involved in the operation. ConsumedCapacity is only // returned if the ReturnConsumedCapacity parameter was specified. For more - // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` @@ -11681,7 +11711,7 @@ type QueryInput struct { // The primary key of the first item that this operation will evaluate. Use // the value that was returned for LastEvaluatedKey in the previous operation. // - // The data type for ExclusiveStartKey must be String, Number or Binary. No + // The data type for ExclusiveStartKey must be String, Number, or Binary. No // set data types are allowed. ExclusiveStartKey map[string]*AttributeValue `type:"map"` @@ -11717,7 +11747,7 @@ type QueryInput struct { // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // - // For more information on expression attribute names, see Accessing Item Attributes + // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` @@ -11763,7 +11793,7 @@ type QueryInput struct { // parameter, you must also provide TableName. IndexName *string `min:"3" type:"string"` - // The condition that specifies the key value(s) for items to be retrieved by + // The condition that specifies the key values for items to be retrieved by // the Query action. // // The condition must perform an equality test on a single partition key value. @@ -11842,7 +11872,7 @@ type QueryInput struct { // items). If DynamoDB processes the number of items up to the limit while processing // the results, it stops the operation and returns the matching values up to // that point, and a key in LastEvaluatedKey to apply in a subsequent operation, - // so that you can pick up where you left off. Also, if the processed data set + // so that you can pick up where you left off. Also, if the processed dataset // size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation // and returns the matching values up to the limit, and a key in LastEvaluatedKey // to apply in a subsequent operation to continue the operation. For more information, @@ -11903,10 +11933,10 @@ type QueryInput struct { // // * ALL_ATTRIBUTES - Returns all of the item attributes from the specified // table or index. If you query a local secondary index, then for each matching - // item in the index DynamoDB will fetch the entire item from the parent - // table. If the index is configured to project all item attributes, then - // all of the data can be obtained from the local secondary index, and no - // fetching is required. + // item in the index, DynamoDB fetches the entire item from the parent table. + // If the index is configured to project all item attributes, then all of + // the data can be obtained from the local secondary index, and no fetching + // is required. // // * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves // all attributes that have been projected into the index. If the index is @@ -11922,7 +11952,7 @@ type QueryInput struct { // index and request only attributes that are projected into that index, // the operation will read only the index and not the table. If any of the // requested attributes are not projected into the local secondary index, - // DynamoDB will fetch each of these attributes from the parent table. This + // DynamoDB fetches each of these attributes from the parent table. This // extra fetching incurs additional throughput cost and latency. If you query // or scan a global secondary index, you can only request attributes that // are projected into the index. Global secondary index queries cannot fetch @@ -12110,8 +12140,8 @@ type QueryOutput struct { // The capacity units consumed by the Query operation. The data returned includes // the total provisioned throughput consumed, along with statistics for the // table and any indexes involved in the operation. ConsumedCapacity is only - // returned if the ReturnConsumedCapacity parameter was specified For more information, - // see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // returned if the ReturnConsumedCapacity parameter was specified. For more + // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` @@ -12707,7 +12737,7 @@ func (s *RestoreSummary) SetSourceTableArn(v string) *RestoreSummary { type RestoreTableFromBackupInput struct { _ struct{} `type:"structure"` - // The ARN associated with the backup. + // The Amazon Resource Name (ARN) associated with the backup. // // BackupArn is a required field BackupArn *string `min:"37" type:"string" required:"true"` @@ -13004,7 +13034,7 @@ type ScanInput struct { // // * If ConsistentRead is false, then the data returned from Scan might not // contain the results from other recently completed write operations (PutItem, - // UpdateItem or DeleteItem). + // UpdateItem, or DeleteItem). // // * If ConsistentRead is true, then all of the write operations that completed // before the Scan began are guaranteed to be contained in the Scan response. @@ -13059,7 +13089,7 @@ type ScanInput struct { // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // - // For more information on expression attribute names, see Accessing Item Attributes + // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` @@ -13081,7 +13111,7 @@ type ScanInput struct { // // ProductStatus IN (:avail, :back, :disc) // - // For more information on expression attribute values, see Specifying Conditions + // For more information on expression attribute values, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` @@ -13106,11 +13136,11 @@ type ScanInput struct { // items). If DynamoDB processes the number of items up to the limit while processing // the results, it stops the operation and returns the matching values up to // that point, and a key in LastEvaluatedKey to apply in a subsequent operation, - // so that you can pick up where you left off. Also, if the processed data set + // so that you can pick up where you left off. Also, if the processed dataset // size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation // and returns the matching values up to the limit, and a key in LastEvaluatedKey // to apply in a subsequent operation to continue the operation. For more information, - // see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) + // see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit *int64 `min:"1" type:"integer"` @@ -13122,7 +13152,7 @@ type ScanInput struct { // If any of the requested attributes are not found, they will not appear in // the result. // - // For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string `type:"string"` @@ -13170,10 +13200,10 @@ type ScanInput struct { // // * ALL_ATTRIBUTES - Returns all of the item attributes from the specified // table or index. If you query a local secondary index, then for each matching - // item in the index DynamoDB will fetch the entire item from the parent - // table. If the index is configured to project all item attributes, then - // all of the data can be obtained from the local secondary index, and no - // fetching is required. + // item in the index, DynamoDB fetches the entire item from the parent table. + // If the index is configured to project all item attributes, then all of + // the data can be obtained from the local secondary index, and no fetching + // is required. // // * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves // all attributes that have been projected into the index. If the index is @@ -13187,13 +13217,13 @@ type ScanInput struct { // This return value is equivalent to specifying AttributesToGet without // specifying any value for Select. If you query or scan a local secondary // index and request only attributes that are projected into that index, - // the operation will read only the index and not the table. If any of the - // requested attributes are not projected into the local secondary index, - // DynamoDB will fetch each of these attributes from the parent table. This - // extra fetching incurs additional throughput cost and latency. If you query - // or scan a global secondary index, you can only request attributes that - // are projected into the index. Global secondary index queries cannot fetch - // attributes from the parent table. + // the operation reads only the index and not the table. If any of the requested + // attributes are not projected into the local secondary index, DynamoDB + // fetches each of these attributes from the parent table. This extra fetching + // incurs additional throughput cost and latency. If you query or scan a + // global secondary index, you can only request attributes that are projected + // into the index. Global secondary index queries cannot fetch attributes + // from the parent table. // // If neither Select nor AttributesToGet are specified, DynamoDB defaults to // ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when @@ -13765,7 +13795,7 @@ type TableDescription struct { // // * KeyType - The role of the attribute: HASH - partition key RANGE - sort // key The partition key of an item is also known as its hash attribute. - // The term "hash attribute" derives from DynamoDB' usage of an internal + // The term "hash attribute" derives from DynamoDB's usage of an internal // hash function to evenly distribute data items across partitions, based // on their partition key values. The sort key of an item is also known as // its range attribute. The term "range attribute" derives from the way DynamoDB @@ -14002,9 +14032,9 @@ func (s *TableDescription) SetTableStatus(v string) *TableDescription { type Tag struct { _ struct{} `type:"structure"` - // The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only - // have up to one tag with the same key. If you try to add an existing tag (same - // key), the existing tag value will be updated to the new value. + // The key of the tag. Tag keys are case sensitive. Each DynamoDB table can + // only have up to one tag with the same key. If you try to add an existing + // tag (same key), the existing tag value will be updated to the new value. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` @@ -14140,10 +14170,10 @@ func (s TagResourceOutput) GoString() string { type TimeToLiveDescription struct { _ struct{} `type:"structure"` - // The name of the Time to Live attribute for items in the table. + // The name of the TTL attribute for items in the table. AttributeName *string `min:"1" type:"string"` - // The Time to Live status for the table. + // The TTL status for the table. TimeToLiveStatus *string `type:"string" enum:"TimeToLiveStatus"` } @@ -14169,19 +14199,19 @@ func (s *TimeToLiveDescription) SetTimeToLiveStatus(v string) *TimeToLiveDescrip return s } -// Represents the settings used to enable or disable Time to Live for the specified -// table. +// Represents the settings used to enable or disable Time to Live (TTL) for +// the specified table. type TimeToLiveSpecification struct { _ struct{} `type:"structure"` - // The name of the Time to Live attribute used to store the expiration time - // for items in the table. + // The name of the TTL attribute used to store the expiration time for items + // in the table. // // AttributeName is a required field AttributeName *string `min:"1" type:"string" required:"true"` - // Indicates whether Time To Live is to be enabled (true) or disabled (false) - // on the table. + // Indicates whether TTL is to be enabled (true) or disabled (false) on the + // table. // // Enabled is a required field Enabled *bool `type:"boolean" required:"true"` @@ -14282,7 +14312,7 @@ type TransactGetItemsInput struct { // is valid. ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"` - // An ordered array of up to 10 TransactGetItem objects, each of which contains + // An ordered array of up to 25 TransactGetItem objects, each of which contains // a Get structure. // // TransactItems is a required field @@ -14346,7 +14376,7 @@ type TransactGetItemsOutput struct { // consumed by the TransactGetItems call in that table. ConsumedCapacity []*ConsumedCapacity `type:"list"` - // An ordered array of up to 10 ItemResponse objects, each of which corresponds + // An ordered array of up to 25 ItemResponse objects, each of which corresponds // to the TransactGetItem object in the same position in the TransactItems array. // Each ItemResponse object contains a Map of the name-value pairs that are // the projected attributes of the requested item. @@ -14470,19 +14500,20 @@ type TransactWriteItemsInput struct { // // Although multiple identical calls using the same client request token produce // the same result on the server (no side effects), the responses to the calls - // may not be the same. If the ReturnConsumedCapacity> parameter is set, then + // might not be the same. If the ReturnConsumedCapacity> parameter is set, then // the initial TransactWriteItems call returns the amount of write capacity - // units consumed in making the changes, and subsequent TransactWriteItems calls - // with the same client token return the amount of read capacity units consumed + // units consumed in making the changes. Subsequent TransactWriteItems calls + // with the same client token return the number of read capacity units consumed // in reading the item. // // A client request token is valid for 10 minutes after the first request that - // uses it completes. After 10 minutes, any request with the same client token - // is treated as a new request. Do not resubmit the same request with the same - // client token for more than 10 minutes or the result may not be idempotent. + // uses it is completed. After 10 minutes, any request with the same client + // token is treated as a new request. Do not resubmit the same request with + // the same client token for more than 10 minutes, or the result might not be + // idempotent. // // If you submit a request with the same client token but a change in other - // parameters within the 10 minute idempotency window, DynamoDB returns an IdempotentParameterMismatch + // parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch // exception. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` @@ -14507,10 +14538,10 @@ type TransactWriteItemsInput struct { // NONE (the default), no statistics are returned. ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"` - // An ordered array of up to 10 TransactWriteItem objects, each of which contains + // An ordered array of up to 25 TransactWriteItem objects, each of which contains // a ConditionCheck, Put, Update, or Delete object. These can operate on items // in different tables, but the tables must reside in the same AWS account and - // region, and no two of them can operate on the same item. + // Region, and no two of them can operate on the same item. // // TransactItems is a required field TransactItems []*TransactWriteItem `min:"1" type:"list" required:"true"` @@ -14589,7 +14620,7 @@ type TransactWriteItemsOutput struct { // A list of tables that were processed by TransactWriteItems and, for each // table, information about any item collections that were affected by individual - // UpdateItem, PutItem or DeleteItem operations. + // UpdateItem, PutItem, or DeleteItem operations. ItemCollectionMetrics map[string][]*ItemCollectionMetrics `type:"map"` } @@ -14618,14 +14649,14 @@ func (s *TransactWriteItemsOutput) SetItemCollectionMetrics(v map[string][]*Item type UntagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon DyanamoDB resource the tags will be removed from. This value is - // an Amazon Resource Name (ARN). + // The DynamoDB resource that the tags will be removed from. This value is an + // Amazon Resource Name (ARN). // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` // A list of tag keys. Existing tags of the resource whose keys are members - // of this list will be removed from the Amazon DynamoDB resource. + // of this list will be removed from the DynamoDB resource. // // TagKeys is a required field TagKeys []*string `type:"list" required:"true"` @@ -14955,7 +14986,7 @@ type UpdateGlobalTableInput struct { // GlobalTableName is a required field GlobalTableName *string `min:"3" type:"string" required:"true"` - // A list of regions that should be added or removed from the global table. + // A list of Regions that should be added or removed from the global table. // // ReplicaUpdates is a required field ReplicaUpdates []*ReplicaUpdate `type:"list" required:"true"` @@ -15051,7 +15082,7 @@ type UpdateGlobalTableSettingsInput struct { // GlobalTableName is a required field GlobalTableName *string `min:"3" type:"string" required:"true"` - // AutoScaling settings for managing provisioned write capacity for the global + // Auto scaling settings for managing provisioned write capacity for the global // table. GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"` @@ -15059,7 +15090,7 @@ type UpdateGlobalTableSettingsInput struct { // a ThrottlingException. GlobalTableProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"` - // Represents the settings for a global table in a region that will be modified. + // Represents the settings for a global table in a Region that will be modified. ReplicaSettingsUpdate []*ReplicaSettingsUpdate `min:"1" type:"list"` } @@ -15165,7 +15196,7 @@ type UpdateGlobalTableSettingsOutput struct { // The name of the global table. GlobalTableName *string `min:"3" type:"string"` - // The region specific settings for the global table. + // The Region-specific settings for the global table. ReplicaSettings []*ReplicaSettingsDescription `type:"list"` } @@ -15211,7 +15242,7 @@ type UpdateItemInput struct { // // * Logical operators: AND | OR | NOT // - // For more information on condition expressions, see Specifying Conditions + // For more information about condition expressions, see Specifying Conditions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ConditionExpression *string `type:"string"` @@ -15246,7 +15277,7 @@ type UpdateItemInput struct { // The name of this attribute conflicts with a reserved word, so it cannot be // used directly in an expression. (For the complete list of reserved words, // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) - // in the Amazon DynamoDB Developer Guide). To work around this, you could specify + // in the Amazon DynamoDB Developer Guide.) To work around this, you could specify // the following for ExpressionAttributeNames: // // * {"#P":"Percentile"} @@ -15258,8 +15289,8 @@ type UpdateItemInput struct { // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // - // For more information on expression attribute names, see Accessing Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // For more information about expression attribute names, see Specifying Item + // Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` @@ -15280,7 +15311,7 @@ type UpdateItemInput struct { // // ProductStatus IN (:avail, :back, :disc) // - // For more information on expression attribute values, see Specifying Conditions + // For more information on expression attribute values, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` @@ -15348,12 +15379,12 @@ type UpdateItemInput struct { TableName *string `min:"3" type:"string" required:"true"` // An expression that defines one or more attributes to be updated, the action - // to be performed on them, and new value(s) for them. + // to be performed on them, and new values for them. // // The following action values are available for UpdateExpression. // // * SET - Adds one or more attributes and values to an item. If any of these - // attribute already exist, they are replaced by the new values. You can + // attributes already exist, they are replaced by the new values. You can // also use SET to add or subtract from an attribute that is of type Number. // For example: SET myNum = myNum + :val SET supports the following functions: // if_not_exists (path, operand) - if the item does not contain an attribute @@ -15620,9 +15651,9 @@ type UpdateTableInput struct { // Represents the DynamoDB Streams configuration for the table. // - // You will receive a ResourceInUseException if you attempt to enable a stream - // on a table that already has a stream, or if you attempt to disable a stream - // on a table which does not have a stream. + // You receive a ResourceInUseException if you try to enable a stream on a table + // that already has a stream, or if you try to disable a stream on a table that + // doesn't have a stream. StreamSpecification *StreamSpecification `type:"structure"` // The name of the table to be updated. diff --git a/vendor/github.com/aws/aws-sdk-go/service/dynamodb/errors.go b/vendor/github.com/aws/aws-sdk-go/service/dynamodb/errors.go index e1b7931960d..71f3e7d3d53 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/dynamodb/errors.go +++ b/vendor/github.com/aws/aws-sdk-go/service/dynamodb/errors.go @@ -184,6 +184,8 @@ const ( // index (LSI) becomes too large, or a similar validation error occurs because // of changes made by the transaction. // + // * The aggregate size of the items in the transaction exceeds 4 MBs. + // // * There is a user error, such as an invalid data format. // // DynamoDB cancels a TransactGetItems request under the following circumstances: @@ -198,6 +200,8 @@ const ( // * There is insufficient provisioned capacity for the transaction to be // completed. // + // * The aggregate size of the items in the transaction exceeds 4 MBs. + // // * There is a user error, such as an invalid data format. // // If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons diff --git a/vendor/github.com/aws/aws-sdk-go/service/ec2/api.go b/vendor/github.com/aws/aws-sdk-go/service/ec2/api.go index 0c6da4f1418..92ea6e19b35 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/ec2/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/ec2/api.go @@ -48411,10 +48411,10 @@ type DescribeByoipCidrsInput struct { // remaining results, make another call with the returned nextToken value. // // MaxResults is a required field - MaxResults *int64 `min:"5" type:"integer" required:"true"` + MaxResults *int64 `min:"1" type:"integer" required:"true"` // The token for the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -48433,11 +48433,8 @@ func (s *DescribeByoipCidrsInput) Validate() error { if s.MaxResults == nil { invalidParams.Add(request.NewErrParamRequired("MaxResults")) } - if s.MaxResults != nil && *s.MaxResults < 5 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) - } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } if invalidParams.Len() > 0 { @@ -48644,7 +48641,7 @@ type DescribeClassicLinkInstancesInput struct { // remaining results, make another call with the returned nextToken value. // // Constraint: If the value is greater than 1000, we return only 1000 items. - MaxResults *int64 `locationName:"maxResults" type:"integer"` + MaxResults *int64 `locationName:"maxResults" min:"5" type:"integer"` // The token for the next page of results. NextToken *string `locationName:"nextToken" type:"string"` @@ -48660,6 +48657,19 @@ func (s DescribeClassicLinkInstancesInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeClassicLinkInstancesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeClassicLinkInstancesInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDryRun sets the DryRun field's value. func (s *DescribeClassicLinkInstancesInput) SetDryRun(v bool) *DescribeClassicLinkInstancesInput { s.DryRun = &v @@ -48746,7 +48756,7 @@ type DescribeClientVpnAuthorizationRulesInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to retrieve the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -48768,9 +48778,6 @@ func (s *DescribeClientVpnAuthorizationRulesInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -48816,7 +48823,7 @@ type DescribeClientVpnAuthorizationRulesOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation @@ -48864,7 +48871,7 @@ type DescribeClientVpnConnectionsInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to retrieve the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -48886,9 +48893,6 @@ func (s *DescribeClientVpnConnectionsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -48934,7 +48938,7 @@ type DescribeClientVpnConnectionsOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation @@ -48980,7 +48984,7 @@ type DescribeClientVpnEndpointsInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to retrieve the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -48999,9 +49003,6 @@ func (s *DescribeClientVpnEndpointsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -49047,7 +49048,7 @@ type DescribeClientVpnEndpointsOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation @@ -49095,7 +49096,7 @@ type DescribeClientVpnRoutesInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to retrieve the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -49117,9 +49118,6 @@ func (s *DescribeClientVpnRoutesInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -49162,7 +49160,7 @@ type DescribeClientVpnRoutesOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` // Information about the Client VPN endpoint routes. Routes []*ClientVpnRoute `locationName:"routes" locationNameList:"item" type:"list"` @@ -49216,7 +49214,7 @@ type DescribeClientVpnTargetNetworksInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to retrieve the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -49238,9 +49236,6 @@ func (s *DescribeClientVpnTargetNetworksInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -49292,7 +49287,7 @@ type DescribeClientVpnTargetNetworksOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation @@ -49613,7 +49608,7 @@ type DescribeEgressOnlyInternetGatewaysInput struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. - MaxResults *int64 `type:"integer"` + MaxResults *int64 `min:"5" type:"integer"` // The token for the next page of results. NextToken *string `type:"string"` @@ -49629,6 +49624,19 @@ func (s DescribeEgressOnlyInternetGatewaysInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeEgressOnlyInternetGatewaysInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeEgressOnlyInternetGatewaysInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDryRun sets the DryRun field's value. func (s *DescribeEgressOnlyInternetGatewaysInput) SetDryRun(v bool) *DescribeEgressOnlyInternetGatewaysInput { s.DryRun = &v @@ -50622,7 +50630,7 @@ type DescribeFpgaImagesInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to retrieve the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` // Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender // of the request), or an AWS owner alias (valid values are amazon | aws-marketplace). @@ -50645,9 +50653,6 @@ func (s *DescribeFpgaImagesInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -50699,7 +50704,7 @@ type DescribeFpgaImagesOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation @@ -51085,7 +51090,7 @@ type DescribeIamInstanceProfileAssociationsInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token to request the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` } // String returns the string representation @@ -51104,9 +51109,6 @@ func (s *DescribeIamInstanceProfileAssociationsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -51146,7 +51148,7 @@ type DescribeIamInstanceProfileAssociationsOutput struct { // The token to use to retrieve the next page of results. This value is null // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation @@ -53173,7 +53175,7 @@ type DescribeMovingAddressesInput struct { // 1000; if MaxResults is given a value outside of this range, an error is returned. // // Default: If no value is provided, the default is 1000. - MaxResults *int64 `locationName:"maxResults" type:"integer"` + MaxResults *int64 `locationName:"maxResults" min:"5" type:"integer"` // The token for the next page of results. NextToken *string `locationName:"nextToken" type:"string"` @@ -53192,6 +53194,19 @@ func (s DescribeMovingAddressesInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeMovingAddressesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeMovingAddressesInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDryRun sets the DryRun field's value. func (s *DescribeMovingAddressesInput) SetDryRun(v bool) *DescribeMovingAddressesInput { s.DryRun = &v @@ -53282,7 +53297,7 @@ type DescribeNatGatewaysInput struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. - MaxResults *int64 `type:"integer"` + MaxResults *int64 `min:"5" type:"integer"` // One or more NAT gateway IDs. NatGatewayIds []*string `locationName:"NatGatewayId" locationNameList:"item" type:"list"` @@ -53301,6 +53316,19 @@ func (s DescribeNatGatewaysInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeNatGatewaysInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeNatGatewaysInput"} + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetFilter sets the Filter field's value. func (s *DescribeNatGatewaysInput) SetFilter(v []*Filter) *DescribeNatGatewaysInput { s.Filter = v @@ -54153,7 +54181,7 @@ type DescribePrincipalIdFormatInput struct { // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned NextToken value. - MaxResults *int64 `type:"integer"` + MaxResults *int64 `min:"1" type:"integer"` // The token to request the next page of results. NextToken *string `type:"string"` @@ -54178,6 +54206,19 @@ func (s DescribePrincipalIdFormatInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribePrincipalIdFormatInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePrincipalIdFormatInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDryRun sets the DryRun field's value. func (s *DescribePrincipalIdFormatInput) SetDryRun(v bool) *DescribePrincipalIdFormatInput { s.DryRun = &v @@ -54243,7 +54284,7 @@ type DescribePublicIpv4PoolsInput struct { MaxResults *int64 `min:"1" type:"integer"` // The token for the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` // The IDs of the address pools. PoolIds []*string `locationName:"PoolId" locationNameList:"item" type:"list"` @@ -54265,9 +54306,6 @@ func (s *DescribePublicIpv4PoolsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -55167,7 +55205,7 @@ type DescribeScheduledInstanceAvailabilityInput struct { // The maximum number of results to return in a single call. This value can // be between 5 and 300. The default value is 300. To retrieve the remaining // results, make another call with the returned NextToken value. - MaxResults *int64 `type:"integer"` + MaxResults *int64 `min:"5" type:"integer"` // The maximum available duration, in hours. This value must be greater than // MinSlotDurationInHours and less than 1,720. @@ -55204,6 +55242,9 @@ func (s *DescribeScheduledInstanceAvailabilityInput) Validate() error { if s.FirstSlotStartTimeRange == nil { invalidParams.Add(request.NewErrParamRequired("FirstSlotStartTimeRange")) } + if s.MaxResults != nil && *s.MaxResults < 5 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) + } if s.Recurrence == nil { invalidParams.Add(request.NewErrParamRequired("Recurrence")) } @@ -56029,7 +56070,7 @@ type DescribeSpotFleetInstancesInput struct { // The maximum number of results to return in a single call. Specify a value // between 1 and 1000. The default value is 1000. To retrieve the remaining // results, make another call with the returned NextToken value. - MaxResults *int64 `locationName:"maxResults" type:"integer"` + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. NextToken *string `locationName:"nextToken" type:"string"` @@ -56053,6 +56094,9 @@ func (s DescribeSpotFleetInstancesInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeSpotFleetInstancesInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeSpotFleetInstancesInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } if s.SpotFleetRequestId == nil { invalidParams.Add(request.NewErrParamRequired("SpotFleetRequestId")) } @@ -56147,7 +56191,7 @@ type DescribeSpotFleetRequestHistoryInput struct { // The maximum number of results to return in a single call. Specify a value // between 1 and 1000. The default value is 1000. To retrieve the remaining // results, make another call with the returned NextToken value. - MaxResults *int64 `locationName:"maxResults" type:"integer"` + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. NextToken *string `locationName:"nextToken" type:"string"` @@ -56176,6 +56220,9 @@ func (s DescribeSpotFleetRequestHistoryInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeSpotFleetRequestHistoryInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeSpotFleetRequestHistoryInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } if s.SpotFleetRequestId == nil { invalidParams.Add(request.NewErrParamRequired("SpotFleetRequestId")) } @@ -57129,7 +57176,7 @@ type DescribeTrafficMirrorFiltersInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token for the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` // The ID of the Traffic Mirror filter. TrafficMirrorFilterIds []*string `locationName:"TrafficMirrorFilterId" locationNameList:"item" type:"list"` @@ -57151,9 +57198,6 @@ func (s *DescribeTrafficMirrorFiltersInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -57259,7 +57303,7 @@ type DescribeTrafficMirrorSessionsInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token for the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` // The ID of the Traffic Mirror session. TrafficMirrorSessionIds []*string `locationName:"TrafficMirrorSessionId" locationNameList:"item" type:"list"` @@ -57281,9 +57325,6 @@ func (s *DescribeTrafficMirrorSessionsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -57383,7 +57424,7 @@ type DescribeTrafficMirrorTargetsInput struct { MaxResults *int64 `min:"5" type:"integer"` // The token for the next page of results. - NextToken *string `min:"1" type:"string"` + NextToken *string `type:"string"` // The ID of the Traffic Mirror targets. TrafficMirrorTargetIds []*string `locationName:"TrafficMirrorTargetId" locationNameList:"item" type:"list"` @@ -57405,9 +57446,6 @@ func (s *DescribeTrafficMirrorTargetsInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 5 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 5)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -93132,6 +93170,9 @@ const ( // EventTypeError is a EventType enum value EventTypeError = "error" + + // EventTypeInformation is a EventType enum value + EventTypeInformation = "information" ) const ( @@ -93654,9 +93695,15 @@ const ( // InstanceTypeR54xlarge is a InstanceType enum value InstanceTypeR54xlarge = "r5.4xlarge" + // InstanceTypeR58xlarge is a InstanceType enum value + InstanceTypeR58xlarge = "r5.8xlarge" + // InstanceTypeR512xlarge is a InstanceType enum value InstanceTypeR512xlarge = "r5.12xlarge" + // InstanceTypeR516xlarge is a InstanceType enum value + InstanceTypeR516xlarge = "r5.16xlarge" + // InstanceTypeR524xlarge is a InstanceType enum value InstanceTypeR524xlarge = "r5.24xlarge" @@ -93675,9 +93722,15 @@ const ( // InstanceTypeR5a4xlarge is a InstanceType enum value InstanceTypeR5a4xlarge = "r5a.4xlarge" + // InstanceTypeR5a8xlarge is a InstanceType enum value + InstanceTypeR5a8xlarge = "r5a.8xlarge" + // InstanceTypeR5a12xlarge is a InstanceType enum value InstanceTypeR5a12xlarge = "r5a.12xlarge" + // InstanceTypeR5a16xlarge is a InstanceType enum value + InstanceTypeR5a16xlarge = "r5a.16xlarge" + // InstanceTypeR5a24xlarge is a InstanceType enum value InstanceTypeR5a24xlarge = "r5a.24xlarge" @@ -93693,9 +93746,15 @@ const ( // InstanceTypeR5d4xlarge is a InstanceType enum value InstanceTypeR5d4xlarge = "r5d.4xlarge" + // InstanceTypeR5d8xlarge is a InstanceType enum value + InstanceTypeR5d8xlarge = "r5d.8xlarge" + // InstanceTypeR5d12xlarge is a InstanceType enum value InstanceTypeR5d12xlarge = "r5d.12xlarge" + // InstanceTypeR5d16xlarge is a InstanceType enum value + InstanceTypeR5d16xlarge = "r5d.16xlarge" + // InstanceTypeR5d24xlarge is a InstanceType enum value InstanceTypeR5d24xlarge = "r5d.24xlarge" @@ -93870,6 +93929,9 @@ const ( // InstanceTypeC524xlarge is a InstanceType enum value InstanceTypeC524xlarge = "c5.24xlarge" + // InstanceTypeC5Metal is a InstanceType enum value + InstanceTypeC5Metal = "c5.metal" + // InstanceTypeC5dLarge is a InstanceType enum value InstanceTypeC5dLarge = "c5d.large" @@ -93987,9 +94049,15 @@ const ( // InstanceTypeM54xlarge is a InstanceType enum value InstanceTypeM54xlarge = "m5.4xlarge" + // InstanceTypeM58xlarge is a InstanceType enum value + InstanceTypeM58xlarge = "m5.8xlarge" + // InstanceTypeM512xlarge is a InstanceType enum value InstanceTypeM512xlarge = "m5.12xlarge" + // InstanceTypeM516xlarge is a InstanceType enum value + InstanceTypeM516xlarge = "m5.16xlarge" + // InstanceTypeM524xlarge is a InstanceType enum value InstanceTypeM524xlarge = "m5.24xlarge" @@ -94008,9 +94076,15 @@ const ( // InstanceTypeM5a4xlarge is a InstanceType enum value InstanceTypeM5a4xlarge = "m5a.4xlarge" + // InstanceTypeM5a8xlarge is a InstanceType enum value + InstanceTypeM5a8xlarge = "m5a.8xlarge" + // InstanceTypeM5a12xlarge is a InstanceType enum value InstanceTypeM5a12xlarge = "m5a.12xlarge" + // InstanceTypeM5a16xlarge is a InstanceType enum value + InstanceTypeM5a16xlarge = "m5a.16xlarge" + // InstanceTypeM5a24xlarge is a InstanceType enum value InstanceTypeM5a24xlarge = "m5a.24xlarge" @@ -94026,9 +94100,15 @@ const ( // InstanceTypeM5d4xlarge is a InstanceType enum value InstanceTypeM5d4xlarge = "m5d.4xlarge" + // InstanceTypeM5d8xlarge is a InstanceType enum value + InstanceTypeM5d8xlarge = "m5d.8xlarge" + // InstanceTypeM5d12xlarge is a InstanceType enum value InstanceTypeM5d12xlarge = "m5d.12xlarge" + // InstanceTypeM5d16xlarge is a InstanceType enum value + InstanceTypeM5d16xlarge = "m5d.16xlarge" + // InstanceTypeM5d24xlarge is a InstanceType enum value InstanceTypeM5d24xlarge = "m5d.24xlarge" diff --git a/vendor/github.com/aws/aws-sdk-go/service/pinpoint/api.go b/vendor/github.com/aws/aws-sdk-go/service/pinpoint/api.go index 416eb6012dd..201422197f8 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/pinpoint/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/pinpoint/api.go @@ -3,6 +3,8 @@ package pinpoint import ( + "fmt" + "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/awsutil" "github.com/aws/aws-sdk-go/aws/request" @@ -54,7 +56,7 @@ func (c *Pinpoint) CreateAppRequest(input *CreateAppInput) (req *request.Request // CreateApp API operation for Amazon Pinpoint. // -// Creates or updates an app. +// Creates an application. // // 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 @@ -65,22 +67,22 @@ func (c *Pinpoint) CreateAppRequest(input *CreateAppInput) (req *request.Request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateApp func (c *Pinpoint) CreateApp(input *CreateAppInput) (*CreateAppOutput, error) { @@ -148,7 +150,8 @@ func (c *Pinpoint) CreateCampaignRequest(input *CreateCampaignInput) (req *reque // CreateCampaign API operation for Amazon Pinpoint. // -// Creates or updates a campaign. +// Creates a new campaign for an application or updates the settings of an existing +// campaign for an application. // // 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 @@ -159,22 +162,22 @@ func (c *Pinpoint) CreateCampaignRequest(input *CreateCampaignInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateCampaign func (c *Pinpoint) CreateCampaign(input *CreateCampaignInput) (*CreateCampaignOutput, error) { @@ -242,7 +245,7 @@ func (c *Pinpoint) CreateExportJobRequest(input *CreateExportJobInput) (req *req // CreateExportJob API operation for Amazon Pinpoint. // -// Creates an export job. +// Creates a new export job for an application. // // 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 @@ -253,22 +256,22 @@ func (c *Pinpoint) CreateExportJobRequest(input *CreateExportJobInput) (req *req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJob func (c *Pinpoint) CreateExportJob(input *CreateExportJobInput) (*CreateExportJobOutput, error) { @@ -336,7 +339,7 @@ func (c *Pinpoint) CreateImportJobRequest(input *CreateImportJobInput) (req *req // CreateImportJob API operation for Amazon Pinpoint. // -// Creates or updates an import job. +// Creates a new import job for an application. // // 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 @@ -347,22 +350,22 @@ func (c *Pinpoint) CreateImportJobRequest(input *CreateImportJobInput) (req *req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJob func (c *Pinpoint) CreateImportJob(input *CreateImportJobInput) (*CreateImportJobOutput, error) { @@ -430,7 +433,8 @@ func (c *Pinpoint) CreateSegmentRequest(input *CreateSegmentInput) (req *request // CreateSegment API operation for Amazon Pinpoint. // -// Used to create or update a segment. +// Creates a new segment for an application or updates the configuration, dimension, +// and other settings for an existing segment that's associated with an application. // // 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 @@ -441,22 +445,22 @@ func (c *Pinpoint) CreateSegmentRequest(input *CreateSegmentInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSegment func (c *Pinpoint) CreateSegment(input *CreateSegmentInput) (*CreateSegmentOutput, error) { @@ -524,7 +528,8 @@ func (c *Pinpoint) DeleteAdmChannelRequest(input *DeleteAdmChannelInput) (req *r // DeleteAdmChannel API operation for Amazon Pinpoint. // -// Delete an ADM channel. +// Disables the ADM channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -535,22 +540,22 @@ func (c *Pinpoint) DeleteAdmChannelRequest(input *DeleteAdmChannelInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAdmChannel func (c *Pinpoint) DeleteAdmChannel(input *DeleteAdmChannelInput) (*DeleteAdmChannelOutput, error) { @@ -618,7 +623,8 @@ func (c *Pinpoint) DeleteApnsChannelRequest(input *DeleteApnsChannelInput) (req // DeleteApnsChannel API operation for Amazon Pinpoint. // -// Deletes the APNs channel for an app. +// Disables the APNs channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -629,22 +635,22 @@ func (c *Pinpoint) DeleteApnsChannelRequest(input *DeleteApnsChannelInput) (req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsChannel func (c *Pinpoint) DeleteApnsChannel(input *DeleteApnsChannelInput) (*DeleteApnsChannelOutput, error) { @@ -712,7 +718,8 @@ func (c *Pinpoint) DeleteApnsSandboxChannelRequest(input *DeleteApnsSandboxChann // DeleteApnsSandboxChannel API operation for Amazon Pinpoint. // -// Delete an APNS sandbox channel. +// Disables the APNs sandbox channel for an application and deletes any existing +// settings for the channel. // // 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 @@ -723,22 +730,22 @@ func (c *Pinpoint) DeleteApnsSandboxChannelRequest(input *DeleteApnsSandboxChann // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsSandboxChannel func (c *Pinpoint) DeleteApnsSandboxChannel(input *DeleteApnsSandboxChannelInput) (*DeleteApnsSandboxChannelOutput, error) { @@ -806,7 +813,8 @@ func (c *Pinpoint) DeleteApnsVoipChannelRequest(input *DeleteApnsVoipChannelInpu // DeleteApnsVoipChannel API operation for Amazon Pinpoint. // -// Delete an APNS VoIP channel +// Disables the APNs VoIP channel for an application and deletes any existing +// settings for the channel. // // 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 @@ -817,22 +825,22 @@ func (c *Pinpoint) DeleteApnsVoipChannelRequest(input *DeleteApnsVoipChannelInpu // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipChannel func (c *Pinpoint) DeleteApnsVoipChannel(input *DeleteApnsVoipChannelInput) (*DeleteApnsVoipChannelOutput, error) { @@ -900,7 +908,8 @@ func (c *Pinpoint) DeleteApnsVoipSandboxChannelRequest(input *DeleteApnsVoipSand // DeleteApnsVoipSandboxChannel API operation for Amazon Pinpoint. // -// Delete an APNS VoIP sandbox channel +// Disables the APNs VoIP sandbox channel for an application and deletes any +// existing settings for the channel. // // 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 @@ -911,22 +920,22 @@ func (c *Pinpoint) DeleteApnsVoipSandboxChannelRequest(input *DeleteApnsVoipSand // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipSandboxChannel func (c *Pinpoint) DeleteApnsVoipSandboxChannel(input *DeleteApnsVoipSandboxChannelInput) (*DeleteApnsVoipSandboxChannelOutput, error) { @@ -994,7 +1003,7 @@ func (c *Pinpoint) DeleteAppRequest(input *DeleteAppInput) (req *request.Request // DeleteApp API operation for Amazon Pinpoint. // -// Deletes an app. +// Deletes an application. // // 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 @@ -1005,22 +1014,22 @@ func (c *Pinpoint) DeleteAppRequest(input *DeleteAppInput) (req *request.Request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApp func (c *Pinpoint) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error) { @@ -1088,7 +1097,8 @@ func (c *Pinpoint) DeleteBaiduChannelRequest(input *DeleteBaiduChannelInput) (re // DeleteBaiduChannel API operation for Amazon Pinpoint. // -// Delete a BAIDU GCM channel +// Disables the Baidu channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -1099,22 +1109,22 @@ func (c *Pinpoint) DeleteBaiduChannelRequest(input *DeleteBaiduChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteBaiduChannel func (c *Pinpoint) DeleteBaiduChannel(input *DeleteBaiduChannelInput) (*DeleteBaiduChannelOutput, error) { @@ -1182,7 +1192,7 @@ func (c *Pinpoint) DeleteCampaignRequest(input *DeleteCampaignInput) (req *reque // DeleteCampaign API operation for Amazon Pinpoint. // -// Deletes a campaign. +// Deletes a campaign from an application. // // 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 @@ -1193,22 +1203,22 @@ func (c *Pinpoint) DeleteCampaignRequest(input *DeleteCampaignInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteCampaign func (c *Pinpoint) DeleteCampaign(input *DeleteCampaignInput) (*DeleteCampaignOutput, error) { @@ -1276,7 +1286,8 @@ func (c *Pinpoint) DeleteEmailChannelRequest(input *DeleteEmailChannelInput) (re // DeleteEmailChannel API operation for Amazon Pinpoint. // -// Delete an email channel. +// Disables the email channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -1287,22 +1298,22 @@ func (c *Pinpoint) DeleteEmailChannelRequest(input *DeleteEmailChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailChannel func (c *Pinpoint) DeleteEmailChannel(input *DeleteEmailChannelInput) (*DeleteEmailChannelOutput, error) { @@ -1370,7 +1381,7 @@ func (c *Pinpoint) DeleteEndpointRequest(input *DeleteEndpointInput) (req *reque // DeleteEndpoint API operation for Amazon Pinpoint. // -// Deletes an endpoint. +// Deletes an endpoint from an application. // // 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 @@ -1381,22 +1392,22 @@ func (c *Pinpoint) DeleteEndpointRequest(input *DeleteEndpointInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpoint func (c *Pinpoint) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error) { @@ -1464,7 +1475,7 @@ func (c *Pinpoint) DeleteEventStreamRequest(input *DeleteEventStreamInput) (req // DeleteEventStream API operation for Amazon Pinpoint. // -// Deletes the event stream for an app. +// Deletes the event stream for an application. // // 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 @@ -1475,22 +1486,22 @@ func (c *Pinpoint) DeleteEventStreamRequest(input *DeleteEventStreamInput) (req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStream func (c *Pinpoint) DeleteEventStream(input *DeleteEventStreamInput) (*DeleteEventStreamOutput, error) { @@ -1558,7 +1569,8 @@ func (c *Pinpoint) DeleteGcmChannelRequest(input *DeleteGcmChannelInput) (req *r // DeleteGcmChannel API operation for Amazon Pinpoint. // -// Deletes the GCM channel for an app. +// Disables the GCM channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -1569,22 +1581,22 @@ func (c *Pinpoint) DeleteGcmChannelRequest(input *DeleteGcmChannelInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteGcmChannel func (c *Pinpoint) DeleteGcmChannel(input *DeleteGcmChannelInput) (*DeleteGcmChannelOutput, error) { @@ -1652,7 +1664,7 @@ func (c *Pinpoint) DeleteSegmentRequest(input *DeleteSegmentInput) (req *request // DeleteSegment API operation for Amazon Pinpoint. // -// Deletes a segment. +// Deletes a segment from an application. // // 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 @@ -1663,22 +1675,22 @@ func (c *Pinpoint) DeleteSegmentRequest(input *DeleteSegmentInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSegment func (c *Pinpoint) DeleteSegment(input *DeleteSegmentInput) (*DeleteSegmentOutput, error) { @@ -1746,7 +1758,8 @@ func (c *Pinpoint) DeleteSmsChannelRequest(input *DeleteSmsChannelInput) (req *r // DeleteSmsChannel API operation for Amazon Pinpoint. // -// Delete an SMS channel. +// Disables the SMS channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -1757,22 +1770,22 @@ func (c *Pinpoint) DeleteSmsChannelRequest(input *DeleteSmsChannelInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsChannel func (c *Pinpoint) DeleteSmsChannel(input *DeleteSmsChannelInput) (*DeleteSmsChannelOutput, error) { @@ -1840,7 +1853,7 @@ func (c *Pinpoint) DeleteUserEndpointsRequest(input *DeleteUserEndpointsInput) ( // DeleteUserEndpoints API operation for Amazon Pinpoint. // -// Deletes endpoints that are associated with a User ID. +// Deletes all the endpoints that are associated with a specific user ID. // // 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 @@ -1851,22 +1864,22 @@ func (c *Pinpoint) DeleteUserEndpointsRequest(input *DeleteUserEndpointsInput) ( // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteUserEndpoints func (c *Pinpoint) DeleteUserEndpoints(input *DeleteUserEndpointsInput) (*DeleteUserEndpointsOutput, error) { @@ -1934,7 +1947,8 @@ func (c *Pinpoint) DeleteVoiceChannelRequest(input *DeleteVoiceChannelInput) (re // DeleteVoiceChannel API operation for Amazon Pinpoint. // -// Delete an Voice channel +// Disables the voice channel for an application and deletes any existing settings +// for the channel. // // 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 @@ -1945,22 +1959,22 @@ func (c *Pinpoint) DeleteVoiceChannelRequest(input *DeleteVoiceChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceChannel func (c *Pinpoint) DeleteVoiceChannel(input *DeleteVoiceChannelInput) (*DeleteVoiceChannelOutput, error) { @@ -2028,7 +2042,8 @@ func (c *Pinpoint) GetAdmChannelRequest(input *GetAdmChannelInput) (req *request // GetAdmChannel API operation for Amazon Pinpoint. // -// Get an ADM channel. +// Retrieves information about the status and settings of the ADM channel for +// an application. // // 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 @@ -2039,22 +2054,22 @@ func (c *Pinpoint) GetAdmChannelRequest(input *GetAdmChannelInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAdmChannel func (c *Pinpoint) GetAdmChannel(input *GetAdmChannelInput) (*GetAdmChannelOutput, error) { @@ -2122,7 +2137,8 @@ func (c *Pinpoint) GetApnsChannelRequest(input *GetApnsChannelInput) (req *reque // GetApnsChannel API operation for Amazon Pinpoint. // -// Returns information about the APNs channel for an app. +// Retrieves information about the status and settings of the APNs channel for +// an application. // // 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 @@ -2133,22 +2149,22 @@ func (c *Pinpoint) GetApnsChannelRequest(input *GetApnsChannelInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsChannel func (c *Pinpoint) GetApnsChannel(input *GetApnsChannelInput) (*GetApnsChannelOutput, error) { @@ -2216,7 +2232,8 @@ func (c *Pinpoint) GetApnsSandboxChannelRequest(input *GetApnsSandboxChannelInpu // GetApnsSandboxChannel API operation for Amazon Pinpoint. // -// Get an APNS sandbox channel. +// Retrieves information about the status and settings of the APNs sandbox channel +// for an application. // // 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 @@ -2227,22 +2244,22 @@ func (c *Pinpoint) GetApnsSandboxChannelRequest(input *GetApnsSandboxChannelInpu // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsSandboxChannel func (c *Pinpoint) GetApnsSandboxChannel(input *GetApnsSandboxChannelInput) (*GetApnsSandboxChannelOutput, error) { @@ -2310,7 +2327,8 @@ func (c *Pinpoint) GetApnsVoipChannelRequest(input *GetApnsVoipChannelInput) (re // GetApnsVoipChannel API operation for Amazon Pinpoint. // -// Get an APNS VoIP channel +// Retrieves information about the status and settings of the APNs VoIP channel +// for an application. // // 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 @@ -2321,22 +2339,22 @@ func (c *Pinpoint) GetApnsVoipChannelRequest(input *GetApnsVoipChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipChannel func (c *Pinpoint) GetApnsVoipChannel(input *GetApnsVoipChannelInput) (*GetApnsVoipChannelOutput, error) { @@ -2404,7 +2422,8 @@ func (c *Pinpoint) GetApnsVoipSandboxChannelRequest(input *GetApnsVoipSandboxCha // GetApnsVoipSandboxChannel API operation for Amazon Pinpoint. // -// Get an APNS VoIPSandbox channel +// Retrieves information about the status and settings of the APNs VoIP sandbox +// channel for an application. // // 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 @@ -2415,22 +2434,22 @@ func (c *Pinpoint) GetApnsVoipSandboxChannelRequest(input *GetApnsVoipSandboxCha // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipSandboxChannel func (c *Pinpoint) GetApnsVoipSandboxChannel(input *GetApnsVoipSandboxChannelInput) (*GetApnsVoipSandboxChannelOutput, error) { @@ -2498,7 +2517,7 @@ func (c *Pinpoint) GetAppRequest(input *GetAppInput) (req *request.Request, outp // GetApp API operation for Amazon Pinpoint. // -// Returns information about an app. +// Retrieves information about an application. // // 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 @@ -2509,22 +2528,22 @@ func (c *Pinpoint) GetAppRequest(input *GetAppInput) (req *request.Request, outp // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApp func (c *Pinpoint) GetApp(input *GetAppInput) (*GetAppOutput, error) { @@ -2592,7 +2611,7 @@ func (c *Pinpoint) GetApplicationSettingsRequest(input *GetApplicationSettingsIn // GetApplicationSettings API operation for Amazon Pinpoint. // -// Used to request the settings for an app. +// Retrieves information about the settings for an application. // // 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 @@ -2603,22 +2622,22 @@ func (c *Pinpoint) GetApplicationSettingsRequest(input *GetApplicationSettingsIn // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationSettings func (c *Pinpoint) GetApplicationSettings(input *GetApplicationSettingsInput) (*GetApplicationSettingsOutput, error) { @@ -2686,7 +2705,7 @@ func (c *Pinpoint) GetAppsRequest(input *GetAppsInput) (req *request.Request, ou // GetApps API operation for Amazon Pinpoint. // -// Returns information about your apps. +// Retrieves information about all of your applications. // // 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 @@ -2697,22 +2716,22 @@ func (c *Pinpoint) GetAppsRequest(input *GetAppsInput) (req *request.Request, ou // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApps func (c *Pinpoint) GetApps(input *GetAppsInput) (*GetAppsOutput, error) { @@ -2780,7 +2799,8 @@ func (c *Pinpoint) GetBaiduChannelRequest(input *GetBaiduChannelInput) (req *req // GetBaiduChannel API operation for Amazon Pinpoint. // -// Get a BAIDU GCM channel +// Retrieves information about the status and settings of the Baidu Cloud Push +// channel for an application. // // 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 @@ -2791,22 +2811,22 @@ func (c *Pinpoint) GetBaiduChannelRequest(input *GetBaiduChannelInput) (req *req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetBaiduChannel func (c *Pinpoint) GetBaiduChannel(input *GetBaiduChannelInput) (*GetBaiduChannelOutput, error) { @@ -2874,7 +2894,8 @@ func (c *Pinpoint) GetCampaignRequest(input *GetCampaignInput) (req *request.Req // GetCampaign API operation for Amazon Pinpoint. // -// Returns information about a campaign. +// Retrieves information about the status, configuration, and other settings +// for a campaign. // // 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 @@ -2885,22 +2906,22 @@ func (c *Pinpoint) GetCampaignRequest(input *GetCampaignInput) (req *request.Req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaign func (c *Pinpoint) GetCampaign(input *GetCampaignInput) (*GetCampaignOutput, error) { @@ -2968,7 +2989,7 @@ func (c *Pinpoint) GetCampaignActivitiesRequest(input *GetCampaignActivitiesInpu // GetCampaignActivities API operation for Amazon Pinpoint. // -// Returns information about the activity performed by a campaign. +// Retrieves information about the activity performed by a campaign. // // 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 @@ -2979,22 +3000,22 @@ func (c *Pinpoint) GetCampaignActivitiesRequest(input *GetCampaignActivitiesInpu // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignActivities func (c *Pinpoint) GetCampaignActivities(input *GetCampaignActivitiesInput) (*GetCampaignActivitiesOutput, error) { @@ -3062,7 +3083,8 @@ func (c *Pinpoint) GetCampaignVersionRequest(input *GetCampaignVersionInput) (re // GetCampaignVersion API operation for Amazon Pinpoint. // -// Returns information about a specific version of a campaign. +// Retrieves information about the status, configuration, and other settings +// for a specific version of a campaign. // // 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 @@ -3073,22 +3095,22 @@ func (c *Pinpoint) GetCampaignVersionRequest(input *GetCampaignVersionInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersion func (c *Pinpoint) GetCampaignVersion(input *GetCampaignVersionInput) (*GetCampaignVersionOutput, error) { @@ -3156,7 +3178,8 @@ func (c *Pinpoint) GetCampaignVersionsRequest(input *GetCampaignVersionsInput) ( // GetCampaignVersions API operation for Amazon Pinpoint. // -// Returns information about your campaign versions. +// Retrieves information about the status, configuration, and other settings +// for all versions of a specific campaign. // // 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 @@ -3167,22 +3190,22 @@ func (c *Pinpoint) GetCampaignVersionsRequest(input *GetCampaignVersionsInput) ( // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersions func (c *Pinpoint) GetCampaignVersions(input *GetCampaignVersionsInput) (*GetCampaignVersionsOutput, error) { @@ -3250,7 +3273,8 @@ func (c *Pinpoint) GetCampaignsRequest(input *GetCampaignsInput) (req *request.R // GetCampaigns API operation for Amazon Pinpoint. // -// Returns information about your campaigns. +// Retrieves information about the status, configuration, and other settings +// for all the campaigns that are associated with an application. // // 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 @@ -3261,22 +3285,22 @@ func (c *Pinpoint) GetCampaignsRequest(input *GetCampaignsInput) (req *request.R // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaigns func (c *Pinpoint) GetCampaigns(input *GetCampaignsInput) (*GetCampaignsOutput, error) { @@ -3344,7 +3368,8 @@ func (c *Pinpoint) GetChannelsRequest(input *GetChannelsInput) (req *request.Req // GetChannels API operation for Amazon Pinpoint. // -// Get all channels. +// Retrieves information about the history and status of each channel for an +// application. // // 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 @@ -3355,22 +3380,22 @@ func (c *Pinpoint) GetChannelsRequest(input *GetChannelsInput) (req *request.Req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetChannels func (c *Pinpoint) GetChannels(input *GetChannelsInput) (*GetChannelsOutput, error) { @@ -3438,7 +3463,8 @@ func (c *Pinpoint) GetEmailChannelRequest(input *GetEmailChannelInput) (req *req // GetEmailChannel API operation for Amazon Pinpoint. // -// Get an email channel. +// Retrieves information about the status and settings of the email channel +// for an application. // // 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 @@ -3449,22 +3475,22 @@ func (c *Pinpoint) GetEmailChannelRequest(input *GetEmailChannelInput) (req *req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailChannel func (c *Pinpoint) GetEmailChannel(input *GetEmailChannelInput) (*GetEmailChannelOutput, error) { @@ -3532,7 +3558,8 @@ func (c *Pinpoint) GetEndpointRequest(input *GetEndpointInput) (req *request.Req // GetEndpoint API operation for Amazon Pinpoint. // -// Returns information about an endpoint. +// Retrieves information about the settings and attributes of a specific endpoint +// for an application. // // 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 @@ -3543,22 +3570,22 @@ func (c *Pinpoint) GetEndpointRequest(input *GetEndpointInput) (req *request.Req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEndpoint func (c *Pinpoint) GetEndpoint(input *GetEndpointInput) (*GetEndpointOutput, error) { @@ -3626,7 +3653,7 @@ func (c *Pinpoint) GetEventStreamRequest(input *GetEventStreamInput) (req *reque // GetEventStream API operation for Amazon Pinpoint. // -// Returns the event stream for an app. +// Retrieves information about the event stream settings for an application. // // 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 @@ -3637,22 +3664,22 @@ func (c *Pinpoint) GetEventStreamRequest(input *GetEventStreamInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEventStream func (c *Pinpoint) GetEventStream(input *GetEventStreamInput) (*GetEventStreamOutput, error) { @@ -3720,7 +3747,8 @@ func (c *Pinpoint) GetExportJobRequest(input *GetExportJobInput) (req *request.R // GetExportJob API operation for Amazon Pinpoint. // -// Returns information about an export job. +// Retrieves information about the status and settings of a specific export +// job for an application. // // 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 @@ -3731,22 +3759,22 @@ func (c *Pinpoint) GetExportJobRequest(input *GetExportJobInput) (req *request.R // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJob func (c *Pinpoint) GetExportJob(input *GetExportJobInput) (*GetExportJobOutput, error) { @@ -3814,7 +3842,8 @@ func (c *Pinpoint) GetExportJobsRequest(input *GetExportJobsInput) (req *request // GetExportJobs API operation for Amazon Pinpoint. // -// Returns information about your export jobs. +// Retrieves information about the status and settings of all the export jobs +// for an application. // // 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 @@ -3825,22 +3854,22 @@ func (c *Pinpoint) GetExportJobsRequest(input *GetExportJobsInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJobs func (c *Pinpoint) GetExportJobs(input *GetExportJobsInput) (*GetExportJobsOutput, error) { @@ -3908,7 +3937,8 @@ func (c *Pinpoint) GetGcmChannelRequest(input *GetGcmChannelInput) (req *request // GetGcmChannel API operation for Amazon Pinpoint. // -// Returns information about the GCM channel for an app. +// Retrieves information about the status and settings of the GCM channel for +// an application. // // 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 @@ -3919,22 +3949,22 @@ func (c *Pinpoint) GetGcmChannelRequest(input *GetGcmChannelInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetGcmChannel func (c *Pinpoint) GetGcmChannel(input *GetGcmChannelInput) (*GetGcmChannelOutput, error) { @@ -4002,7 +4032,8 @@ func (c *Pinpoint) GetImportJobRequest(input *GetImportJobInput) (req *request.R // GetImportJob API operation for Amazon Pinpoint. // -// Returns information about an import job. +// Retrieves information about the status and settings of a specific import +// job for an application. // // 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 @@ -4013,22 +4044,22 @@ func (c *Pinpoint) GetImportJobRequest(input *GetImportJobInput) (req *request.R // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJob func (c *Pinpoint) GetImportJob(input *GetImportJobInput) (*GetImportJobOutput, error) { @@ -4096,7 +4127,8 @@ func (c *Pinpoint) GetImportJobsRequest(input *GetImportJobsInput) (req *request // GetImportJobs API operation for Amazon Pinpoint. // -// Returns information about your import jobs. +// Retrieves information about the status and settings of all the import jobs +// for an application. // // 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 @@ -4107,22 +4139,22 @@ func (c *Pinpoint) GetImportJobsRequest(input *GetImportJobsInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobs func (c *Pinpoint) GetImportJobs(input *GetImportJobsInput) (*GetImportJobsOutput, error) { @@ -4190,7 +4222,8 @@ func (c *Pinpoint) GetSegmentRequest(input *GetSegmentInput) (req *request.Reque // GetSegment API operation for Amazon Pinpoint. // -// Returns information about a segment. +// Retrieves information about the configuration, dimension, and other settings +// for a specific segment that's associated with an application. // // 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 @@ -4201,22 +4234,22 @@ func (c *Pinpoint) GetSegmentRequest(input *GetSegmentInput) (req *request.Reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegment func (c *Pinpoint) GetSegment(input *GetSegmentInput) (*GetSegmentOutput, error) { @@ -4284,7 +4317,8 @@ func (c *Pinpoint) GetSegmentExportJobsRequest(input *GetSegmentExportJobsInput) // GetSegmentExportJobs API operation for Amazon Pinpoint. // -// Returns a list of export jobs for a specific segment. +// Retrieves information about the status and settings of the export jobs for +// a segment. // // 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 @@ -4295,22 +4329,22 @@ func (c *Pinpoint) GetSegmentExportJobsRequest(input *GetSegmentExportJobsInput) // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentExportJobs func (c *Pinpoint) GetSegmentExportJobs(input *GetSegmentExportJobsInput) (*GetSegmentExportJobsOutput, error) { @@ -4378,7 +4412,8 @@ func (c *Pinpoint) GetSegmentImportJobsRequest(input *GetSegmentImportJobsInput) // GetSegmentImportJobs API operation for Amazon Pinpoint. // -// Returns a list of import jobs for a specific segment. +// Retrieves information about the status and settings of the import jobs for +// a segment. // // 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 @@ -4389,22 +4424,22 @@ func (c *Pinpoint) GetSegmentImportJobsRequest(input *GetSegmentImportJobsInput) // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentImportJobs func (c *Pinpoint) GetSegmentImportJobs(input *GetSegmentImportJobsInput) (*GetSegmentImportJobsOutput, error) { @@ -4472,7 +4507,8 @@ func (c *Pinpoint) GetSegmentVersionRequest(input *GetSegmentVersionInput) (req // GetSegmentVersion API operation for Amazon Pinpoint. // -// Returns information about a segment version. +// Retrieves information about the configuration, dimension, and other settings +// for a specific version of a segment that's associated with an application. // // 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 @@ -4483,22 +4519,22 @@ func (c *Pinpoint) GetSegmentVersionRequest(input *GetSegmentVersionInput) (req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersion func (c *Pinpoint) GetSegmentVersion(input *GetSegmentVersionInput) (*GetSegmentVersionOutput, error) { @@ -4566,7 +4602,8 @@ func (c *Pinpoint) GetSegmentVersionsRequest(input *GetSegmentVersionsInput) (re // GetSegmentVersions API operation for Amazon Pinpoint. // -// Returns information about your segment versions. +// Retrieves information about the configuration, dimension, and other settings +// for all versions of a specific segment that's associated with an application. // // 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 @@ -4577,22 +4614,22 @@ func (c *Pinpoint) GetSegmentVersionsRequest(input *GetSegmentVersionsInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersions func (c *Pinpoint) GetSegmentVersions(input *GetSegmentVersionsInput) (*GetSegmentVersionsOutput, error) { @@ -4660,7 +4697,8 @@ func (c *Pinpoint) GetSegmentsRequest(input *GetSegmentsInput) (req *request.Req // GetSegments API operation for Amazon Pinpoint. // -// Used to get information about your segments. +// Retrieves information about the configuration, dimension, and other settings +// for all the segments that are associated with an application. // // 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 @@ -4671,22 +4709,22 @@ func (c *Pinpoint) GetSegmentsRequest(input *GetSegmentsInput) (req *request.Req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegments func (c *Pinpoint) GetSegments(input *GetSegmentsInput) (*GetSegmentsOutput, error) { @@ -4754,7 +4792,8 @@ func (c *Pinpoint) GetSmsChannelRequest(input *GetSmsChannelInput) (req *request // GetSmsChannel API operation for Amazon Pinpoint. // -// Get an SMS channel. +// Retrieves information about the status and settings of the SMS channel for +// an application. // // 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 @@ -4765,22 +4804,22 @@ func (c *Pinpoint) GetSmsChannelRequest(input *GetSmsChannelInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsChannel func (c *Pinpoint) GetSmsChannel(input *GetSmsChannelInput) (*GetSmsChannelOutput, error) { @@ -4848,7 +4887,8 @@ func (c *Pinpoint) GetUserEndpointsRequest(input *GetUserEndpointsInput) (req *r // GetUserEndpoints API operation for Amazon Pinpoint. // -// Returns information about the endpoints that are associated with a User ID. +// Retrieves information about all the endpoints that are associated with a +// specific user ID. // // 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 @@ -4859,22 +4899,22 @@ func (c *Pinpoint) GetUserEndpointsRequest(input *GetUserEndpointsInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetUserEndpoints func (c *Pinpoint) GetUserEndpoints(input *GetUserEndpointsInput) (*GetUserEndpointsOutput, error) { @@ -4942,7 +4982,8 @@ func (c *Pinpoint) GetVoiceChannelRequest(input *GetVoiceChannelInput) (req *req // GetVoiceChannel API operation for Amazon Pinpoint. // -// Get a Voice Channel +// Retrieves information about the status and settings of the voice channel +// for an application. // // 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 @@ -4953,22 +4994,22 @@ func (c *Pinpoint) GetVoiceChannelRequest(input *GetVoiceChannelInput) (req *req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetVoiceChannel func (c *Pinpoint) GetVoiceChannel(input *GetVoiceChannelInput) (*GetVoiceChannelOutput, error) { @@ -5036,7 +5077,8 @@ func (c *Pinpoint) ListTagsForResourceRequest(input *ListTagsForResourceInput) ( // ListTagsForResource API operation for Amazon Pinpoint. // -// Get list of all tags for a given resource arn +// Retrieves all the tags (keys and values) that are associated with an application, +// campaign, or segment. // // 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 @@ -5110,7 +5152,7 @@ func (c *Pinpoint) PhoneNumberValidateRequest(input *PhoneNumberValidateInput) ( // PhoneNumberValidate API operation for Amazon Pinpoint. // -// Returns information about the specified phone number. +// Retrieves information about a phone number. // // 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 @@ -5121,22 +5163,22 @@ func (c *Pinpoint) PhoneNumberValidateRequest(input *PhoneNumberValidateInput) ( // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PhoneNumberValidate func (c *Pinpoint) PhoneNumberValidate(input *PhoneNumberValidateInput) (*PhoneNumberValidateOutput, error) { @@ -5204,7 +5246,8 @@ func (c *Pinpoint) PutEventStreamRequest(input *PutEventStreamInput) (req *reque // PutEventStream API operation for Amazon Pinpoint. // -// Use to create or update the event stream for an app. +// Creates a new event stream for an application or updates the settings of +// an existing event stream for an application. // // 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 @@ -5215,22 +5258,22 @@ func (c *Pinpoint) PutEventStreamRequest(input *PutEventStreamInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventStream func (c *Pinpoint) PutEventStream(input *PutEventStreamInput) (*PutEventStreamOutput, error) { @@ -5298,8 +5341,8 @@ func (c *Pinpoint) PutEventsRequest(input *PutEventsInput) (req *request.Request // PutEvents API operation for Amazon Pinpoint. // -// Use to record events for endpoints. This method creates events and creates -// or updates the endpoints that those events are associated with. +// Creates a new event to record for endpoints, or creates or updates endpoint +// data that existing events are associated with. // // 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 @@ -5310,22 +5353,22 @@ func (c *Pinpoint) PutEventsRequest(input *PutEventsInput) (req *request.Request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEvents func (c *Pinpoint) PutEvents(input *PutEventsInput) (*PutEventsOutput, error) { @@ -5393,7 +5436,8 @@ func (c *Pinpoint) RemoveAttributesRequest(input *RemoveAttributesInput) (req *r // RemoveAttributes API operation for Amazon Pinpoint. // -// Used to remove the attributes for an app +// Removes one or more attributes, of the same attribute type, from all the +// endpoints that are associated with an application. // // 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 @@ -5404,22 +5448,22 @@ func (c *Pinpoint) RemoveAttributesRequest(input *RemoveAttributesInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RemoveAttributes func (c *Pinpoint) RemoveAttributes(input *RemoveAttributesInput) (*RemoveAttributesOutput, error) { @@ -5487,7 +5531,7 @@ func (c *Pinpoint) SendMessagesRequest(input *SendMessagesInput) (req *request.R // SendMessages API operation for Amazon Pinpoint. // -// Used to send a direct message. +// Creates and sends a direct message. // // 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 @@ -5498,22 +5542,22 @@ func (c *Pinpoint) SendMessagesRequest(input *SendMessagesInput) (req *request.R // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendMessages func (c *Pinpoint) SendMessages(input *SendMessagesInput) (*SendMessagesOutput, error) { @@ -5581,7 +5625,7 @@ func (c *Pinpoint) SendUsersMessagesRequest(input *SendUsersMessagesInput) (req // SendUsersMessages API operation for Amazon Pinpoint. // -// Used to send a message to a list of users. +// Creates and sends a message to a list of users. // // 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 @@ -5592,22 +5636,22 @@ func (c *Pinpoint) SendUsersMessagesRequest(input *SendUsersMessagesInput) (req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessages func (c *Pinpoint) SendUsersMessages(input *SendUsersMessagesInput) (*SendUsersMessagesOutput, error) { @@ -5676,7 +5720,7 @@ func (c *Pinpoint) TagResourceRequest(input *TagResourceInput) (req *request.Req // TagResource API operation for Amazon Pinpoint. // -// Adds tags to a resource. +// Adds one or more tags (keys and values) to an application, campaign, or segment. // // 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 @@ -5751,7 +5795,8 @@ func (c *Pinpoint) UntagResourceRequest(input *UntagResourceInput) (req *request // UntagResource API operation for Amazon Pinpoint. // -// Remove tags from a resource. +// Removes one or more tags (keys and values) from an application, campaign, +// or segment. // // 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 @@ -5825,7 +5870,7 @@ func (c *Pinpoint) UpdateAdmChannelRequest(input *UpdateAdmChannelInput) (req *r // UpdateAdmChannel API operation for Amazon Pinpoint. // -// Update an ADM channel. +// Updates the ADM channel settings for an application. // // 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 @@ -5836,22 +5881,22 @@ func (c *Pinpoint) UpdateAdmChannelRequest(input *UpdateAdmChannelInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateAdmChannel func (c *Pinpoint) UpdateAdmChannel(input *UpdateAdmChannelInput) (*UpdateAdmChannelOutput, error) { @@ -5919,7 +5964,7 @@ func (c *Pinpoint) UpdateApnsChannelRequest(input *UpdateApnsChannelInput) (req // UpdateApnsChannel API operation for Amazon Pinpoint. // -// Use to update the APNs channel for an app. +// Updates the APNs channel settings for an application. // // 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 @@ -5930,22 +5975,22 @@ func (c *Pinpoint) UpdateApnsChannelRequest(input *UpdateApnsChannelInput) (req // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsChannel func (c *Pinpoint) UpdateApnsChannel(input *UpdateApnsChannelInput) (*UpdateApnsChannelOutput, error) { @@ -6013,7 +6058,7 @@ func (c *Pinpoint) UpdateApnsSandboxChannelRequest(input *UpdateApnsSandboxChann // UpdateApnsSandboxChannel API operation for Amazon Pinpoint. // -// Update an APNS sandbox channel. +// Updates the APNs sandbox channel settings for an application. // // 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 @@ -6024,22 +6069,22 @@ func (c *Pinpoint) UpdateApnsSandboxChannelRequest(input *UpdateApnsSandboxChann // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsSandboxChannel func (c *Pinpoint) UpdateApnsSandboxChannel(input *UpdateApnsSandboxChannelInput) (*UpdateApnsSandboxChannelOutput, error) { @@ -6107,7 +6152,7 @@ func (c *Pinpoint) UpdateApnsVoipChannelRequest(input *UpdateApnsVoipChannelInpu // UpdateApnsVoipChannel API operation for Amazon Pinpoint. // -// Update an APNS VoIP channel +// Updates the APNs VoIP channel settings for an application. // // 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 @@ -6118,22 +6163,22 @@ func (c *Pinpoint) UpdateApnsVoipChannelRequest(input *UpdateApnsVoipChannelInpu // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsVoipChannel func (c *Pinpoint) UpdateApnsVoipChannel(input *UpdateApnsVoipChannelInput) (*UpdateApnsVoipChannelOutput, error) { @@ -6201,7 +6246,7 @@ func (c *Pinpoint) UpdateApnsVoipSandboxChannelRequest(input *UpdateApnsVoipSand // UpdateApnsVoipSandboxChannel API operation for Amazon Pinpoint. // -// Update an APNS VoIP sandbox channel +// Updates the settings for the APNs VoIP sandbox channel for an application. // // 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 @@ -6212,22 +6257,22 @@ func (c *Pinpoint) UpdateApnsVoipSandboxChannelRequest(input *UpdateApnsVoipSand // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsVoipSandboxChannel func (c *Pinpoint) UpdateApnsVoipSandboxChannel(input *UpdateApnsVoipSandboxChannelInput) (*UpdateApnsVoipSandboxChannelOutput, error) { @@ -6295,7 +6340,7 @@ func (c *Pinpoint) UpdateApplicationSettingsRequest(input *UpdateApplicationSett // UpdateApplicationSettings API operation for Amazon Pinpoint. // -// Used to update the settings for an app. +// Updates the settings for an application. // // 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 @@ -6306,22 +6351,22 @@ func (c *Pinpoint) UpdateApplicationSettingsRequest(input *UpdateApplicationSett // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApplicationSettings func (c *Pinpoint) UpdateApplicationSettings(input *UpdateApplicationSettingsInput) (*UpdateApplicationSettingsOutput, error) { @@ -6389,7 +6434,7 @@ func (c *Pinpoint) UpdateBaiduChannelRequest(input *UpdateBaiduChannelInput) (re // UpdateBaiduChannel API operation for Amazon Pinpoint. // -// Update a BAIDU GCM channel +// Updates the settings of the Baidu channel for an application. // // 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 @@ -6400,22 +6445,22 @@ func (c *Pinpoint) UpdateBaiduChannelRequest(input *UpdateBaiduChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateBaiduChannel func (c *Pinpoint) UpdateBaiduChannel(input *UpdateBaiduChannelInput) (*UpdateBaiduChannelOutput, error) { @@ -6483,7 +6528,7 @@ func (c *Pinpoint) UpdateCampaignRequest(input *UpdateCampaignInput) (req *reque // UpdateCampaign API operation for Amazon Pinpoint. // -// Use to update a campaign. +// Updates the settings for a campaign. // // 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 @@ -6494,22 +6539,22 @@ func (c *Pinpoint) UpdateCampaignRequest(input *UpdateCampaignInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateCampaign func (c *Pinpoint) UpdateCampaign(input *UpdateCampaignInput) (*UpdateCampaignOutput, error) { @@ -6577,7 +6622,7 @@ func (c *Pinpoint) UpdateEmailChannelRequest(input *UpdateEmailChannelInput) (re // UpdateEmailChannel API operation for Amazon Pinpoint. // -// Update an email channel. +// Updates the status and settings of the email channel for an application. // // 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 @@ -6588,22 +6633,22 @@ func (c *Pinpoint) UpdateEmailChannelRequest(input *UpdateEmailChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailChannel func (c *Pinpoint) UpdateEmailChannel(input *UpdateEmailChannelInput) (*UpdateEmailChannelOutput, error) { @@ -6671,7 +6716,10 @@ func (c *Pinpoint) UpdateEndpointRequest(input *UpdateEndpointInput) (req *reque // UpdateEndpoint API operation for Amazon Pinpoint. // -// Creates or updates an endpoint. +// Creates a new endpoint for an application or updates the settings and attributes +// of an existing endpoint for an application. You can also use this operation +// to define custom attributes (Attributes, Metrics, and UserAttributes properties) +// for an endpoint. // // 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 @@ -6682,22 +6730,22 @@ func (c *Pinpoint) UpdateEndpointRequest(input *UpdateEndpointInput) (req *reque // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpoint func (c *Pinpoint) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error) { @@ -6765,7 +6813,10 @@ func (c *Pinpoint) UpdateEndpointsBatchRequest(input *UpdateEndpointsBatchInput) // UpdateEndpointsBatch API operation for Amazon Pinpoint. // -// Use to update a batch of endpoints. +// Creates a new batch of endpoints for an application or updates the settings +// and attributes of a batch of existing endpoints for an application. You can +// also use this operation to define custom attributes (Attributes, Metrics, +// and UserAttributes properties) for a batch of endpoints. // // 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 @@ -6776,22 +6827,22 @@ func (c *Pinpoint) UpdateEndpointsBatchRequest(input *UpdateEndpointsBatchInput) // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointsBatch func (c *Pinpoint) UpdateEndpointsBatch(input *UpdateEndpointsBatchInput) (*UpdateEndpointsBatchOutput, error) { @@ -6859,7 +6910,7 @@ func (c *Pinpoint) UpdateGcmChannelRequest(input *UpdateGcmChannelInput) (req *r // UpdateGcmChannel API operation for Amazon Pinpoint. // -// Use to update the GCM channel for an app. +// Updates the status and settings of the GCM channel for an application. // // 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 @@ -6870,22 +6921,22 @@ func (c *Pinpoint) UpdateGcmChannelRequest(input *UpdateGcmChannelInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannel func (c *Pinpoint) UpdateGcmChannel(input *UpdateGcmChannelInput) (*UpdateGcmChannelOutput, error) { @@ -6953,7 +7004,8 @@ func (c *Pinpoint) UpdateSegmentRequest(input *UpdateSegmentInput) (req *request // UpdateSegment API operation for Amazon Pinpoint. // -// Used to update a segment. +// Creates a new segment for an application or updates the configuration, dimension, +// and other settings for an existing segment that's associated with an application. // // 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 @@ -6964,22 +7016,22 @@ func (c *Pinpoint) UpdateSegmentRequest(input *UpdateSegmentInput) (req *request // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSegment func (c *Pinpoint) UpdateSegment(input *UpdateSegmentInput) (*UpdateSegmentOutput, error) { @@ -7047,7 +7099,7 @@ func (c *Pinpoint) UpdateSmsChannelRequest(input *UpdateSmsChannelInput) (req *r // UpdateSmsChannel API operation for Amazon Pinpoint. // -// Update an SMS channel. +// Updates the status and settings of the SMS channel for an application. // // 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 @@ -7058,22 +7110,22 @@ func (c *Pinpoint) UpdateSmsChannelRequest(input *UpdateSmsChannelInput) (req *r // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannel func (c *Pinpoint) UpdateSmsChannel(input *UpdateSmsChannelInput) (*UpdateSmsChannelOutput, error) { @@ -7141,7 +7193,7 @@ func (c *Pinpoint) UpdateVoiceChannelRequest(input *UpdateVoiceChannelInput) (re // UpdateVoiceChannel API operation for Amazon Pinpoint. // -// Update an Voice channel +// Updates the status and settings of the voice channel for an application. // // 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 @@ -7152,22 +7204,22 @@ func (c *Pinpoint) UpdateVoiceChannelRequest(input *UpdateVoiceChannelInput) (re // // Returned Error Codes: // * ErrCodeBadRequestException "BadRequestException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeInternalServerErrorException "InternalServerErrorException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeForbiddenException "ForbiddenException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeNotFoundException "NotFoundException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeMethodNotAllowedException "MethodNotAllowedException" -// Simple message object. +// Provides information about an API request or response. // // * ErrCodeTooManyRequestsException "TooManyRequestsException" -// Simple message object. +// Provides information about an API request or response. // // See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateVoiceChannel func (c *Pinpoint) UpdateVoiceChannel(input *UpdateVoiceChannelInput) (*UpdateVoiceChannelOutput, error) { @@ -7191,17 +7243,23 @@ func (c *Pinpoint) UpdateVoiceChannelWithContext(ctx aws.Context, input *UpdateV return out, req.Send() } -// Amazon Device Messaging channel definition. +// Specifies the status and settings of the ADM (Amazon Device Messaging) channel +// for an application. type ADMChannelRequest struct { _ struct{} `type:"structure"` - // The Client ID that you obtained from the Amazon App Distribution Portal. - ClientId *string `type:"string"` + // The Client ID that you received from Amazon to send messages by using ADM. + // + // ClientId is a required field + ClientId *string `type:"string" required:"true"` - // The Client Secret that you obtained from the Amazon App Distribution Portal. - ClientSecret *string `type:"string"` + // The Client Secret that you received from Amazon to send messages by using + // ADM. + // + // ClientSecret is a required field + ClientSecret *string `type:"string" required:"true"` - // Indicates whether or not the channel is enabled for sending messages. + // Specifies whether to enable the ADM channel for the application. Enabled *bool `type:"boolean"` } @@ -7215,6 +7273,22 @@ func (s ADMChannelRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ADMChannelRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ADMChannelRequest"} + if s.ClientId == nil { + invalidParams.Add(request.NewErrParamRequired("ClientId")) + } + if s.ClientSecret == nil { + invalidParams.Add(request.NewErrParamRequired("ClientSecret")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetClientId sets the ClientId field's value. func (s *ADMChannelRequest) SetClientId(v string) *ADMChannelRequest { s.ClientId = &v @@ -7233,38 +7307,43 @@ func (s *ADMChannelRequest) SetEnabled(v bool) *ADMChannelRequest { return s } -// Amazon Device Messaging channel definition. +// Provides information about the status and settings of the ADM (Amazon Device +// Messaging) channel for an application. type ADMChannelResponse struct { _ struct{} `type:"structure"` - // The ID of the application to which the channel applies. + // The unique identifier for the application that the ADM channel applies to. ApplicationId *string `type:"string"` - // The date and time when this channel was created. + // The date and time when the ADM channel was enabled. CreationDate *string `type:"string"` - // Indicates whether or not the channel is enabled for sending messages. + // Specifies whether the ADM channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // (Deprecated) An identifier for the channel. Retained for backwards compatibility. + // (Deprecated) An identifier for the ADM channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Indicates whether or not the channel is archived. + // Specifies whether the ADM channel is archived. IsArchived *bool `type:"boolean"` - // The user who last updated this channel. + // The user who last modified the ADM channel. LastModifiedBy *string `type:"string"` - // The date and time when this channel was last modified. + // The date and time when the ADM channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. For this channel, the value is always "ADM." - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the ADM + // channel, this value is ADM. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // The channel version. + // The current version of the ADM channel. Version *int64 `type:"integer"` } @@ -7338,75 +7417,86 @@ func (s *ADMChannelResponse) SetVersion(v int64) *ADMChannelResponse { return s } -// ADM Message. +// Specifies the settings for a one-time message that's sent directly to an +// endpoint through the ADM (Amazon Device Messaging) channel. type ADMMessage struct { _ struct{} `type:"structure"` - // The action that occurs if the user taps a push notification delivered by - // the campaign: OPEN_APP - Your app launches, or it becomes the foreground - // app if it has been sent to the background. This is the default action. DEEP_LINK - // - Uses deep linking features in iOS and Android to open your app and display - // a designated user interface within the app. URL - The default mobile browser - // on the user's device launches and opens a web page at the URL you specify. - // Possible values include: OPEN_APP | DEEP_LINK | URL + // The action to occur if the recipient taps the push notification. Valid values + // are: + // + // * OPEN_APP - Your app opens or it becomes the foreground app if it was + // sent to the background. This is the default action. + // + // * DEEP_LINK - Your app opens and displays a designated user interface + // in the app. This action uses the deep-linking features of the Android + // platform. + // + // * URL - The default mobile browser on the recipient's device opens and + // loads the web page at a URL that you specify. Action *string `type:"string" enum:"Action"` - // The message body of the notification. + // The body of the notification message. Body *string `type:"string"` - // Optional. Arbitrary string used to indicate multiple messages are logically - // the same and that ADM is allowed to drop previously enqueued messages in - // favor of this one. + // An arbitrary string that indicates that multiple messages are logically the + // same and that Amazon Device Messaging (ADM) can drop previously enqueued + // messages in favor of this message. ConsolidationKey *string `type:"string"` - // The data payload used for a silent push. This payload is added to the notifications' - // data.pinpoint.jsonBody' object + // The JSON data payload to use for the push notification, if the notification + // is a silent push notification. This payload is added to the data.pinpoint.jsonBody + // object of the notification. Data map[string]*string `type:"map"` - // Optional. Number of seconds ADM should retain the message if the device is - // offline + // The amount of time, in seconds, that ADM should store the message if the + // recipient's device is offline. Amazon Pinpoint specifies this value in the + // expiresAfter parameter when it sends the notification message to ADM. ExpiresAfter *string `type:"string"` - // The icon image name of the asset saved in your application. + // The icon image name of the asset saved in your app. IconReference *string `type:"string"` - // The URL that points to an image used as the large icon to the notification - // content view. + // The URL of the large icon image to display in the content view of the push + // notification. ImageIconUrl *string `type:"string"` - // The URL that points to an image used in the push notification. + // The URL of an image to display in the push notification. ImageUrl *string `type:"string"` - // Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify - // data integrity + // The base64-encoded, MD5 checksum of the value specified by the Data property. + // ADM uses the MD5 value to verify the integrity of the data. MD5 *string `type:"string"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the notification + // message. This value overrides the message. RawContent *string `type:"string"` - // Indicates if the message should display on the users device. Silent pushes - // can be used for Remote Configuration and Phone Home use cases. + // Specifies whether the notification is a silent push notification, which is + // a push notification that doesn't display on a recipient's device. Silent + // push notifications can be used for cases such as updating an app's configuration + // or supporting phone home functionality. SilentPush *bool `type:"boolean"` - // The URL that points to an image used as the small icon for the notification - // which will be used to represent the notification in the status bar and content - // view + // The URL of the small icon image to display in the status bar and the content + // view of the push notification. SmallImageIconUrl *string `type:"string"` - // Indicates a sound to play when the device receives the notification. Supports - // default, or the filename of a sound resource bundled in the app. Android - // sound files must reside in /res/raw/ + // The sound to play when the recipient receives the push notification. You + // can use the default stream or specify the file name of a sound resource that's + // bundled in your app. On an Android platform, the sound file must reside in + // /res/raw/. Sound *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the notification message. You can + // override the default variables with individual address variables. Substitutions map[string][]*string `type:"map"` - // The message title that displays above the message on the user's device. + // The title to display above the notification message on the recipient's device. Title *string `type:"string"` - // The URL to open in the user's mobile browser. Used if the value for Action - // is URL. + // The URL to open in the recipient's default mobile browser, if a recipient + // taps the push notification and the value of the Action property is URL. Url *string `type:"string"` } @@ -7516,32 +7606,39 @@ func (s *ADMMessage) SetUrl(v string) *ADMMessage { return s } -// Apple Push Notification Service channel definition. +// Specifies the status and settings of the APNs (Apple Push Notification service) +// channel for an application. type APNSChannelRequest struct { _ struct{} `type:"structure"` - // The bundle id used for APNs Tokens. + // The bundle identifier that's assigned to your iOS app. This identifier is + // used for APNs tokens. BundleId *string `type:"string"` - // The distribution certificate from Apple. + // The APNs client certificate that you received from Apple, if you want Amazon + // Pinpoint to communicate with APNs by using an APNs certificate. Certificate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that you want Amazon Pinpoint to use when + // authenticating with APNs, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the APNs channel for the application. Enabled *bool `type:"boolean"` - // The certificate private key. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with APNs. PrivateKey *string `type:"string"` - // The team id used for APNs Tokens. + // The identifier that's assigned to your Apple developer account team. This + // identifier is used for APNs tokens. TeamId *string `type:"string"` - // The token key used for APNs Tokens. + // The authentication key to use for APNs tokens. TokenKey *string `type:"string"` - // The token key used for APNs Tokens. + // The key identifier that's assigned to your APNs signing key, if you want + // Amazon Pinpoint to communicate with APNs by using APNs tokens. TokenKeyId *string `type:"string"` } @@ -7603,45 +7700,52 @@ func (s *APNSChannelRequest) SetTokenKeyId(v string) *APNSChannelRequest { return s } -// Apple Distribution Push Notification Service channel definition. +// Provides information about the status and settings of the APNs (Apple Push +// Notification service) channel for an application. type APNSChannelResponse struct { _ struct{} `type:"structure"` - // The ID of the application that the channel applies to. + // The unique identifier for the application that the APNs channel applies to. ApplicationId *string `type:"string"` - // The date and time when this channel was created. + // The date and time when the APNs channel was enabled. CreationDate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with APNs for this channel, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the APNs channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Indicates whether the channel is configured with a key for APNs token authentication. - // Provide a token key by setting the TokenKey attribute. + // Specifies whether the APNs channel is configured to communicate with APNs + // by using APNs tokens. To provide an authentication key for APNs tokens, set + // the TokenKey property of the channel. HasTokenKey *bool `type:"boolean"` - // (Deprecated) An identifier for the channel. Retained for backwards compatibility. + // (Deprecated) An identifier for the APNs channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Indicates whether or not the channel is archived. + // Specifies whether the APNs channel is archived. IsArchived *bool `type:"boolean"` - // The user who last updated this channel. + // The user who last modified the APNs channel. LastModifiedBy *string `type:"string"` - // The date and time when this channel was last modified. + // The date and time when the APNs channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. For this channel, the value is always "ADM." - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the APNs + // channel, this value is APNS. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // The channel version. + // The current version of the APNs channel. Version *int64 `type:"integer"` } @@ -7727,94 +7831,115 @@ func (s *APNSChannelResponse) SetVersion(v int64) *APNSChannelResponse { return s } -// APNS Message. +// Specifies the settings for a one-time message that's sent directly to an +// endpoint through the APNs (Apple Push Notification service) channel. type APNSMessage struct { _ struct{} `type:"structure"` - // The action that occurs if the user taps a push notification delivered by - // the campaign: OPEN_APP - Your app launches, or it becomes the foreground - // app if it has been sent to the background. This is the default action. DEEP_LINK - // - Uses deep linking features in iOS and Android to open your app and display - // a designated user interface within the app. URL - The default mobile browser - // on the user's device launches and opens a web page at the URL you specify. - // Possible values include: OPEN_APP | DEEP_LINK | URL + // The action to occur if the recipient taps the push notification. Valid values + // are: + // + // * OPEN_APP - Your app opens or it becomes the foreground app if it was + // sent to the background. This is the default action. + // + // * DEEP_LINK - Your app opens and displays a designated user interface + // in the app. This setting uses the deep-linking features of the iOS platform. + // + // * URL - The default mobile browser on the recipient's device opens and + // loads the web page at a URL that you specify. Action *string `type:"string" enum:"Action"` - // Include this key when you want the system to modify the badge of your app - // icon. If this key is not included in the dictionary, the badge is not changed. - // To remove the badge, set the value of this key to 0. + // The key that indicates whether and how to modify the badge of your app's + // icon when the recipient receives the push notification. If this key isn't + // included in the dictionary, the badge doesn't change. To remove the badge, + // set this value to 0. Badge *int64 `type:"integer"` - // The message body of the notification. + // The body of the notification message. Body *string `type:"string"` - // Provide this key with a string value that represents the notification's type. - // This value corresponds to the value in the identifier property of one of - // your app's registered categories. + // The key that indicates the notification type for the push notification. This + // key is a value that's defined by the identifier property of one of your app's + // registered categories. Category *string `type:"string"` - // An ID that, if assigned to multiple messages, causes APNs to coalesce the - // messages into a single push notification instead of delivering each message - // individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this - // value to set the apns-collapse-id request header when it sends the message - // to APNs. + // An arbitrary identifier that, if assigned to multiple messages, APNs uses + // to coalesce the messages into a single push notification instead of delivering + // each message individually. This value can't exceed 64 bytes. + // + // Amazon Pinpoint specifies this value in the apns-collapse-id request header + // when it sends the notification message to APNs. CollapseId *string `type:"string"` - // The data payload used for a silent push. This payload is added to the notifications' - // data.pinpoint.jsonBody' object + // The JSON payload to use for a silent push notification. This payload is added + // to the data.pinpoint.jsonBody object of the notification. Data map[string]*string `type:"map"` - // A URL that refers to the location of an image or video that you want to display - // in the push notification. + // The URL of an image or video to display in the push notification. MediaUrl *string `type:"string"` - // The preferred authentication method, either "CERTIFICATE" or "TOKEN" + // The authentication method that you want Amazon Pinpoint to use when authenticating + // with Apple Push Notification service (APNs), CERTIFICATE or TOKEN. PreferredAuthenticationMethod *string `type:"string"` - // The message priority. Amazon Pinpoint uses this value to set the apns-priority - // request header when it sends the message to APNs. Accepts the following values:"5" - // - Low priority. Messages might be delayed, delivered in groups, and throttled."10" - // - High priority. Messages are sent immediately. High priority messages must - // cause an alert, sound, or badge on the receiving device.The default value - // is "10".The equivalent values for FCM or GCM messages are "normal" and "high". - // Amazon Pinpoint accepts these values for APNs messages and converts them.For - // more information about the apns-priority parameter, see Communicating with - // APNs in the APNs Local and Remote Notification Programming Guide. + // para>5 - Low priority, the notification might be delayed, delivered as part + // of a group, or throttled. + // /listitem> + // 10 - High priority, the notification is sent immediately. This is the default + // value. A high priority notification should trigger an alert, play a sound, + // or badge your app's icon on the recipient's device. + // /para> + // Amazon Pinpoint specifies this value in the apns-priority request header + // when it sends the notification message to APNs. + // + // The equivalent values for Firebase Cloud Messaging (FCM), formerly Google + // Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify + // an FCM value for this property, Amazon Pinpoint accepts and converts the + // value to the corresponding APNs value. Priority *string `type:"string"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the notification + // message. This value overrides the message. RawContent *string `type:"string"` - // Indicates if the message should display on the users device. Silent pushes - // can be used for Remote Configuration and Phone Home use cases. + // Specifies whether the notification is a silent push notification, which is + // a push notification that doesn't display on a recipient's device. Silent + // push notifications can be used for cases such as updating an app's configuration, + // displaying messages in an in-app message center, or supporting phone home + // functionality. SilentPush *bool `type:"boolean"` - // Include this key when you want the system to play a sound. The value of this - // key is the name of a sound file in your app's main bundle or in the Library/Sounds - // folder of your app's data container. If the sound file cannot be found, or - // if you specify defaultfor the value, the system plays the default alert sound. + // The key for the sound to play when the recipient receives the push notification. + // The value of this key is the name of a sound file in your app's main bundle + // or the Library/Sounds folder in your app's data container. If the sound file + // can't be found or you specify default for the value, the system plays the + // default alert sound. Sound *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the notification message. You can + // override these default variables with individual address variables. Substitutions map[string][]*string `type:"map"` - // Provide this key with a string value that represents the app-specific identifier - // for grouping notifications. If you provide a Notification Content app extension, - // you can use this value to group your notifications together. + // The key that represents your app-specific identifier for grouping notifications. + // If you provide a Notification Content app extension, you can use this value + // to group your notifications together. ThreadId *string `type:"string"` - // The length of time (in seconds) that APNs stores and attempts to deliver - // the message. If the value is 0, APNs does not store the message or attempt - // to deliver it more than once. Amazon Pinpoint uses this value to set the - // apns-expiration request header when it sends the message to APNs. + // The amount of time, in seconds, that APNs should store and attempt to deliver + // the push notification, if the service is unable to deliver the notification + // the first time. If this value is 0, APNs treats the notification as if it + // expires immediately and the service doesn't store or try to deliver the notification + // again. + // + // Amazon Pinpoint specifies this value in the apns-expiration request header + // when it sends the notification message to APNs. TimeToLive *int64 `type:"integer"` - // The message title that displays above the message on the user's device. + // The title to display above the notification message on the recipient's device. Title *string `type:"string"` - // The URL to open in the user's mobile browser. Used if the value for Action - // is URL. + // The URL to open in the recipient's default mobile browser, if a recipient + // taps the push notification and the value of the Action property is URL. Url *string `type:"string"` } @@ -7930,32 +8055,41 @@ func (s *APNSMessage) SetUrl(v string) *APNSMessage { return s } -// Apple Development Push Notification Service channel definition. +// Specifies the status and settings of the APNs (Apple Push Notification service) +// sandbox channel for an application. type APNSSandboxChannelRequest struct { _ struct{} `type:"structure"` - // The bundle id used for APNs Tokens. + // The bundle identifier that's assigned to your iOS app. This identifier is + // used for APNs tokens. BundleId *string `type:"string"` - // The distribution certificate from Apple. + // The APNs client certificate that you received from Apple, if you want Amazon + // Pinpoint to communicate with the APNs sandbox environment by using an APNs + // certificate. Certificate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that you want Amazon Pinpoint to use when + // authenticating with the APNs sandbox environment, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the APNs sandbox channel for the application. Enabled *bool `type:"boolean"` - // The certificate private key. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with the APNs sandbox environment. PrivateKey *string `type:"string"` - // The team id used for APNs Tokens. + // The identifier that's assigned to your Apple developer account team. This + // identifier is used for APNs tokens. TeamId *string `type:"string"` - // The token key used for APNs Tokens. + // The authentication key to use for APNs tokens. TokenKey *string `type:"string"` - // The token key used for APNs Tokens. + // The key identifier that's assigned to your APNs signing key, if you want + // Amazon Pinpoint to communicate with the APNs sandbox environment by using + // APNs tokens. TokenKeyId *string `type:"string"` } @@ -8017,45 +8151,53 @@ func (s *APNSSandboxChannelRequest) SetTokenKeyId(v string) *APNSSandboxChannelR return s } -// Apple Development Push Notification Service channel definition. +// Provides information about the status and settings of the APNs (Apple Push +// Notification service) sandbox channel for an application. type APNSSandboxChannelResponse struct { _ struct{} `type:"structure"` - // The ID of the application to which the channel applies. + // The unique identifier for the application that the APNs sandbox channel applies + // to. ApplicationId *string `type:"string"` - // When was this segment created + // The date and time when the APNs sandbox channel was enabled. CreationDate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with the APNs sandbox environment for this channel, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the APNs sandbox channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Indicates whether the channel is configured with a key for APNs token authentication. - // Provide a token key by setting the TokenKey attribute. + // Specifies whether the APNs sandbox channel is configured to communicate with + // APNs by using APNs tokens. To provide an authentication key for APNs tokens, + // set the TokenKey property of the channel. HasTokenKey *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the APNs sandbox channel. This property is + // retained only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the APNs sandbox channel is archived. IsArchived *bool `type:"boolean"` - // Who last updated this entry + // The user who last modified the APNs sandbox channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time when the APNs sandbox channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. Will be APNS_SANDBOX. - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the APNs + // sandbox channel, this value is APNS_SANDBOX. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Version of channel + // The current version of the APNs sandbox channel. Version *int64 `type:"integer"` } @@ -8141,32 +8283,39 @@ func (s *APNSSandboxChannelResponse) SetVersion(v int64) *APNSSandboxChannelResp return s } -// Apple VoIP Push Notification Service channel definition. +// Specifies the status and settings of the APNs (Apple Push Notification service) +// VoIP channel for an application. type APNSVoipChannelRequest struct { _ struct{} `type:"structure"` - // The bundle id used for APNs Tokens. + // The bundle identifier that's assigned to your iOS app. This identifier is + // used for APNs tokens. BundleId *string `type:"string"` - // The distribution certificate from Apple. + // The APNs client certificate that you received from Apple, if you want Amazon + // Pinpoint to communicate with APNs by using an APNs certificate. Certificate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that you want Amazon Pinpoint to use when + // authenticating with APNs, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the APNs VoIP channel for the application. Enabled *bool `type:"boolean"` - // The certificate private key. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with APNs. PrivateKey *string `type:"string"` - // The team id used for APNs Tokens. + // The identifier that's assigned to your Apple developer account team. This + // identifier is used for APNs tokens. TeamId *string `type:"string"` - // The token key used for APNs Tokens. + // The authentication key to use for APNs tokens. TokenKey *string `type:"string"` - // The token key used for APNs Tokens. + // The key identifier that's assigned to your APNs signing key, if you want + // Amazon Pinpoint to communicate with APNs by using APNs tokens. TokenKeyId *string `type:"string"` } @@ -8228,44 +8377,53 @@ func (s *APNSVoipChannelRequest) SetTokenKeyId(v string) *APNSVoipChannelRequest return s } -// Apple VoIP Push Notification Service channel definition. +// Provides information about the status and settings of the APNs (Apple Push +// Notification service) VoIP channel for an application. type APNSVoipChannelResponse struct { _ struct{} `type:"structure"` - // Application id + // The unique identifier for the application that the APNs VoIP channel applies + // to. ApplicationId *string `type:"string"` - // When was this segment created + // The date and time when the APNs VoIP channel was enabled. CreationDate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with APNs for this channel, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the APNs VoIP channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // If the channel is registered with a token key for authentication. + // Specifies whether the APNs VoIP channel is configured to communicate with + // APNs by using APNs tokens. To provide an authentication key for APNs tokens, + // set the TokenKey property of the channel. HasTokenKey *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the APNs VoIP channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the APNs VoIP channel is archived. IsArchived *bool `type:"boolean"` - // Who made the last change + // The user who last modified the APNs VoIP channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time when the APNs VoIP channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. Will be APNS. - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the APNs + // VoIP channel, this value is APNS_VOIP. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Version of channel + // The current version of the APNs VoIP channel. Version *int64 `type:"integer"` } @@ -8351,32 +8509,42 @@ func (s *APNSVoipChannelResponse) SetVersion(v int64) *APNSVoipChannelResponse { return s } -// Apple VoIP Developer Push Notification Service channel definition. +// Specifies the status and settings of the APNs (Apple Push Notification service) +// VoIP sandbox channel for an application. type APNSVoipSandboxChannelRequest struct { _ struct{} `type:"structure"` - // The bundle id used for APNs Tokens. + // The bundle identifier that's assigned to your iOS app. This identifier is + // used for APNs tokens. BundleId *string `type:"string"` - // The distribution certificate from Apple. + // The APNs client certificate that you received from Apple, if you want Amazon + // Pinpoint to communicate with the APNs sandbox environment by using an APNs + // certificate. Certificate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that you want Amazon Pinpoint to use when + // authenticating with the APNs sandbox environment for this channel, key or + // certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the APNs VoIP sandbox channel is enabled for the application. Enabled *bool `type:"boolean"` - // The certificate private key. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with the APNs sandbox environment. PrivateKey *string `type:"string"` - // The team id used for APNs Tokens. + // The identifier that's assigned to your Apple developer account team. This + // identifier is used for APNs tokens. TeamId *string `type:"string"` - // The token key used for APNs Tokens. + // The authentication key to use for APNs tokens. TokenKey *string `type:"string"` - // The token key used for APNs Tokens. + // The key identifier that's assigned to your APNs signing key, if you want + // Amazon Pinpoint to communicate with the APNs sandbox environment by using + // APNs tokens. TokenKeyId *string `type:"string"` } @@ -8438,44 +8606,53 @@ func (s *APNSVoipSandboxChannelRequest) SetTokenKeyId(v string) *APNSVoipSandbox return s } -// Apple VoIP Developer Push Notification Service channel definition. +// Provides information about the status and settings of the APNs (Apple Push +// Notification service) VoIP sandbox channel for an application. type APNSVoipSandboxChannelResponse struct { _ struct{} `type:"structure"` - // Application id + // The unique identifier for the application that the APNs VoIP sandbox channel + // applies to. ApplicationId *string `type:"string"` - // When was this segment created + // The date and time when the APNs VoIP sandbox channel was enabled. CreationDate *string `type:"string"` - // The default authentication method used for APNs. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with the APNs sandbox environment for this channel, key or certificate. DefaultAuthenticationMethod *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the APNs VoIP sandbox channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // If the channel is registered with a token key for authentication. + // Specifies whether the APNs VoIP sandbox channel is configured to communicate + // with APNs by using APNs tokens. To provide an authentication key for APNs + // tokens, set the TokenKey property of the channel. HasTokenKey *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the APNs VoIP sandbox channel. This property + // is retained only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the APNs VoIP sandbox channel is archived. IsArchived *bool `type:"boolean"` - // Who made the last change + // The user who last modified the APNs VoIP sandbox channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time when the APNs VoIP sandbox channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. Will be APNS. - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the APNs + // VoIP sandbox channel, this value is APNS_VOIP_SANDBOX. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Version of channel + // The current version of the APNs VoIP sandbox channel. Version *int64 `type:"integer"` } @@ -8561,15 +8738,17 @@ func (s *APNSVoipSandboxChannelResponse) SetVersion(v int64) *APNSVoipSandboxCha return s } -// Activities for campaign. +// Provides information about the activities that were performed by a campaign. type ActivitiesResponse struct { _ struct{} `type:"structure"` - // List of campaign activities - Item []*ActivityResponse `type:"list"` + // An array of responses, one for each activity that was performed by the campaign. + // + // Item is a required field + Item []*ActivityResponse `type:"list" required:"true"` - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. + // The string to use in a subsequent request to get the next page of results + // in a paginated response. This value is null if there are no additional pages. NextToken *string `type:"string"` } @@ -8595,50 +8774,60 @@ func (s *ActivitiesResponse) SetNextToken(v string) *ActivitiesResponse { return s } -// Activity definition +// Provides information about an activity that was performed by a campaign. type ActivityResponse struct { _ struct{} `type:"structure"` - // The ID of the application to which the campaign applies. - ApplicationId *string `type:"string"` + // The unique identifier for the application that the campaign applies to. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The ID of the campaign to which the activity applies. - CampaignId *string `type:"string"` + // The unique identifier for the campaign that the activity applies to. + // + // CampaignId is a required field + CampaignId *string `type:"string" required:"true"` - // The actual time the activity was marked CANCELLED or COMPLETED. Provided - // in ISO 8601 format. + // The actual time, in ISO 8601 format, when the activity was marked CANCELLED + // or COMPLETED. End *string `type:"string"` - // The unique activity ID. - Id *string `type:"string"` + // The unique identifier for the activity. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // Indicates whether the activity succeeded.Valid values: SUCCESS, FAIL + // Specifies whether the activity succeeded. Possible values are SUCCESS and + // FAIL. Result *string `type:"string"` - // The scheduled start time for the activity in ISO 8601 format. + // The scheduled start time, in ISO 8601 format, for the activity. ScheduledStart *string `type:"string"` - // The actual start time of the activity in ISO 8601 format. + // The actual start time, in ISO 8601 format, of the activity. Start *string `type:"string"` - // The state of the activity.Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, - // CANCELLED, COMPLETED + // The state of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, + // PAUSED, CANCELLED, and COMPLETED. State *string `type:"string"` - // The total number of endpoints to which the campaign successfully delivered - // messages. + // The total number of endpoints that the campaign successfully delivered messages + // to. SuccessfulEndpointCount *int64 `type:"integer"` - // The total number of timezones completed. + // The total number of time zones that were completed. TimezonesCompletedCount *int64 `type:"integer"` - // The total number of unique timezones present in the segment. + // The total number of unique time zones that are in the segment for the campaign. TimezonesTotalCount *int64 `type:"integer"` - // The total number of endpoints to which the campaign attempts to deliver messages. + // The total number of endpoints that the campaign attempted to deliver messages + // to. TotalEndpointCount *int64 `type:"integer"` - // The ID of a variation of the campaign used for A/B testing. + // The unique identifier for the campaign treatment that the activity applies + // to. A treatment is a variation of a campaign that's used for A/B testing + // of a campaign. TreatmentId *string `type:"string"` } @@ -8730,32 +8919,35 @@ func (s *ActivityResponse) SetTreatmentId(v string) *ActivityResponse { return s } -// Address configuration. +// Specifies address-based configuration settings for a message that's sent +// directly to an endpoint. type AddressConfiguration struct { _ struct{} `type:"structure"` - // Body override. If specified will override default body. + // The message body to use instead of the default message body. This value overrides + // the default message body. BodyOverride *string `type:"string"` - // The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX - // | ADM | SMS | EMAIL | BAIDU + // The channel to use when sending the message. ChannelType *string `type:"string" enum:"ChannelType"` - // A map of custom attributes to attributes to be attached to the message for - // this address. This payload is added to the push notification's 'data.pinpoint' - // object or added to the email/sms delivery receipt event attributes. + // An object that maps custom attributes to attributes for the address and is + // attached to the message. For a push notification, this payload is added to + // the data.pinpoint object. For an email or text message, this payload is added + // to email/SMS delivery receipt event attributes. Context map[string]*string `type:"map"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the notification + // message. This value overrides the message. RawContent *string `type:"string"` - // A map of substitution values for the message to be merged with the DefaultMessage's - // substitutions. Substitutions on this map take precedence over the all other - // substitutions. + // An object that maps variable values for the message. Amazon Pinpoint merges + // these values with the variable values specified by properties of the DefaultMessage + // object. The substitutions in this map take precedence over all other substitutions. Substitutions map[string][]*string `type:"map"` - // Title override. If specified will override default title if applicable. + // The message title to use instead of the default message title. This value + // overrides the default message title. TitleOverride *string `type:"string"` } @@ -8805,20 +8997,30 @@ func (s *AddressConfiguration) SetTitleOverride(v string) *AddressConfiguration return s } -// Application Response. +// Provides information about an application. type ApplicationResponse struct { _ struct{} `type:"structure"` - // The arn for the application. - Arn *string `type:"string"` + // The Amazon Resource Name (ARN) of the application. + // + // Arn is a required field + Arn *string `type:"string" required:"true"` - // The unique application ID. - Id *string `type:"string"` + // The unique identifier for the application. This identifier is displayed as + // the Project ID on the Amazon Pinpoint console. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // The display name of the application. - Name *string `type:"string"` + // The display name of the application. This name is displayed as the Project + // name on the Amazon Pinpoint console. + // + // Name is a required field + Name *string `type:"string" required:"true"` - // The Tags for the application. + // A string-to-string map of key-value pairs that identifies the tags that are + // associated with the application. Each tag consists of a required tag key + // and an associated tag value. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -8856,38 +9058,45 @@ func (s *ApplicationResponse) SetTags(v map[string]*string) *ApplicationResponse return s } -// Application settings. +// Provides information about an application, including the default settings +// for an application. type ApplicationSettingsResource struct { _ struct{} `type:"structure"` - // The unique ID for the application. - ApplicationId *string `type:"string"` + // The unique identifier for the application. This identifier is displayed as + // the Project ID on the Amazon Pinpoint console. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // Default campaign hook. + // The settings for the AWS Lambda function to use by default as a code hook + // for campaigns in the application. CampaignHook *CampaignHook `type:"structure"` - // The date that the settings were last updated in ISO 8601 format. + // The date and time, in ISO 8601 format, when the application's settings were + // last modified. LastModifiedDate *string `type:"string"` - // The default campaign limits for the app. These limits apply to each campaign - // for the app, unless the campaign overrides the default with limits of its - // own. + // The default sending limits for campaigns in the application. Limits *CampaignLimits `type:"structure"` - // The default quiet time for the app. Campaigns in the app don't send messages - // to endpoints during the quiet time.Note: Make sure that your endpoints include - // the Demographics.Timezone attribute if you plan to enable a quiet time for - // your app. If your endpoints don't include this attribute, they'll receive - // the messages that you send them, even if quiet time is enabled.When you set - // up an app to use quiet time, campaigns in that app don't send messages during - // the time range you specified, as long as all of the following are true:- - // The endpoint includes a valid Demographic.Timezone attribute.- The current - // time in the endpoint's time zone is later than or equal to the time specified - // in the QuietTime.Start attribute for the app (or campaign, if applicable).- - // The current time in the endpoint's time zone is earlier than or equal to - // the time specified in the QuietTime.End attribute for the app (or campaign, - // if applicable).Individual campaigns within the app can have their own quiet - // time settings, which override the quiet time settings at the app level. + // The default quiet time for campaigns in the application. Quiet time is a + // specific time range when campaigns don't send messages to endpoints, if all + // the following conditions are met: + // + // * The EndpointDemographic.Timezone property of the endpoint is set to + // a valid value. + // + // * The current time in the endpoint's time zone is later than or equal + // to the time specified by the QuietTime.Start property for the application + // (or a campaign that has custom quiet time settings). + // + // * The current time in the endpoint's time zone is earlier than or equal + // to the time specified by the QuietTime.End property for the application + // (or a campaign that has custom quiet time settings). + // + // If any of the preceding conditions isn't met, the endpoint will receive messages + // from a campaign, even if quiet time is enabled. QuietTime *QuietTime `type:"structure"` } @@ -8931,15 +9140,15 @@ func (s *ApplicationSettingsResource) SetQuietTime(v *QuietTime) *ApplicationSet return s } -// Get Applications Result. +// Provides information about all of your applications. type ApplicationsResponse struct { _ struct{} `type:"structure"` - // List of applications returned in this page. + // An array of responses, one for each application that was returned. Item []*ApplicationResponse `type:"list"` - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. + // The string to use in a subsequent request to get the next page of results + // in a paginated response. This value is null if there are no additional pages. NextToken *string `type:"string"` } @@ -8965,19 +9174,22 @@ func (s *ApplicationsResponse) SetNextToken(v string) *ApplicationsResponse { return s } -// Custom attibute dimension +// Specifies attribute-based criteria for including or excluding endpoints from +// a segment. type AttributeDimension struct { _ struct{} `type:"structure"` - // The type of dimension:INCLUSIVE - Endpoints that match the criteria are included - // in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded - // from the segment. + // The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints + // that match the criteria are included in the segment; and, EXCLUSIVE, endpoints + // that match the criteria are excluded from the segment. AttributeType *string `type:"string" enum:"AttributeType"` - // The criteria values for the segment dimension. Endpoints with matching attribute - // values are included or excluded from the segment, depending on the setting - // for Type. - Values []*string `type:"list"` + // The criteria values to use for the segment dimension. Depending on the value + // of the AttributeType property, endpoints are included or excluded from the + // segment if their attribute values match the criteria values. + // + // Values is a required field + Values []*string `type:"list" required:"true"` } // String returns the string representation @@ -8990,6 +9202,19 @@ func (s AttributeDimension) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *AttributeDimension) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AttributeDimension"} + if s.Values == nil { + invalidParams.Add(request.NewErrParamRequired("Values")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAttributeType sets the AttributeType field's value. func (s *AttributeDimension) SetAttributeType(v string) *AttributeDimension { s.AttributeType = &v @@ -9002,17 +9227,31 @@ func (s *AttributeDimension) SetValues(v []*string) *AttributeDimension { return s } -// Attributes. +// Provides information about the type and the names of attributes that were +// removed from all the endpoints that are associated with an application. type AttributesResource struct { _ struct{} `type:"structure"` - // The unique ID for the application. - ApplicationId *string `type:"string"` + // The unique identifier for the application. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The attribute type for the application. - AttributeType *string `type:"string"` + // The type of attribute or attributes that were removed from the endpoints. + // Valid values are: + // + // * endpoint-custom-attributes - Custom attributes that describe endpoints + // + // * endpoint-custom-metrics - Custom metrics that your app reports to Amazon + // Pinpoint for endpoints + // + // * endpoint-user-attributes - Custom attributes that describe users + // + // AttributeType is a required field + AttributeType *string `type:"string" required:"true"` - // The attributes for the application. + // An array that specifies the names of the attributes that were removed from + // the endpoints. Attributes []*string `type:"list"` } @@ -9044,18 +9283,25 @@ func (s *AttributesResource) SetAttributes(v []*string) *AttributesResource { return s } -// Baidu Cloud Push credentials +// Specifies the status and settings of the Baidu (Baidu Cloud Push) channel +// for an application. type BaiduChannelRequest struct { _ struct{} `type:"structure"` - // Platform credential API key from Baidu. - ApiKey *string `type:"string"` + // The API key that you received from the Baidu Cloud Push service to communicate + // with the service. + // + // ApiKey is a required field + ApiKey *string `type:"string" required:"true"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the Baidu channel for the application. Enabled *bool `type:"boolean"` - // Platform credential Secret key from Baidu. - SecretKey *string `type:"string"` + // The secret key that you received from the Baidu Cloud Push service to communicate + // with the service. + // + // SecretKey is a required field + SecretKey *string `type:"string" required:"true"` } // String returns the string representation @@ -9068,6 +9314,22 @@ func (s BaiduChannelRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *BaiduChannelRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BaiduChannelRequest"} + if s.ApiKey == nil { + invalidParams.Add(request.NewErrParamRequired("ApiKey")) + } + if s.SecretKey == nil { + invalidParams.Add(request.NewErrParamRequired("SecretKey")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetApiKey sets the ApiKey field's value. func (s *BaiduChannelRequest) SetApiKey(v string) *BaiduChannelRequest { s.ApiKey = &v @@ -9086,41 +9348,50 @@ func (s *BaiduChannelRequest) SetSecretKey(v string) *BaiduChannelRequest { return s } -// Baidu Cloud Messaging channel definition +// Provides information about the status and settings of the Baidu (Baidu Cloud +// Push) channel for an application. type BaiduChannelResponse struct { _ struct{} `type:"structure"` - // Application id + // The unique identifier for the application that the Baidu channel applies + // to. ApplicationId *string `type:"string"` - // When was this segment created + // The date and time when the Baidu channel was enabled. CreationDate *string `type:"string"` - // The Baidu API key from Baidu. - Credential *string `type:"string"` + // The API key that you received from the Baidu Cloud Push service to communicate + // with the service. + // + // Credential is a required field + Credential *string `type:"string" required:"true"` - // If the channel is enabled for sending messages. + // Specifies whether the Baidu channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the Baidu channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the Baidu channel is archived. IsArchived *bool `type:"boolean"` - // Who made the last change + // The user who last modified the Baidu channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time when the Baidu channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. Will be BAIDU - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the Baidu + // channel, this value is BAIDU. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Version of channel + // The current version of the Baidu channel. Version *int64 `type:"integer"` } @@ -9200,67 +9471,77 @@ func (s *BaiduChannelResponse) SetVersion(v int64) *BaiduChannelResponse { return s } -// Baidu Message. +// Specifies the settings for a one-time message that's sent directly to an +// endpoint through the Baidu (Baidu Cloud Push) channel. type BaiduMessage struct { _ struct{} `type:"structure"` - // The action that occurs if the user taps a push notification delivered by - // the campaign: OPEN_APP - Your app launches, or it becomes the foreground - // app if it has been sent to the background. This is the default action. DEEP_LINK - // - Uses deep linking features in iOS and Android to open your app and display - // a designated user interface within the app. URL - The default mobile browser - // on the user's device launches and opens a web page at the URL you specify. - // Possible values include: OPEN_APP | DEEP_LINK | URL + // The action to occur if the recipient taps the push notification. Valid values + // are: + // + // * OPEN_APP - Your app opens or it becomes the foreground app if it was + // sent to the background. This is the default action. + // + // * DEEP_LINK - Your app opens and displays a designated user interface + // in the app. This action uses the deep-linking features of the Android + // platform. + // + // * URL - The default mobile browser on the recipient's device opens and + // loads the web page at a URL that you specify. Action *string `type:"string" enum:"Action"` - // The message body of the notification. + // The body of the notification message. Body *string `type:"string"` - // The data payload used for a silent push. This payload is added to the notifications' - // data.pinpoint.jsonBody' object + // The JSON data payload to use for the push notification, if the notification + // is a silent push notification. This payload is added to the data.pinpoint.jsonBody + // object of the notification. Data map[string]*string `type:"map"` - // The icon image name of the asset saved in your application. + // The icon image name of the asset saved in your app. IconReference *string `type:"string"` - // The URL that points to an image used as the large icon to the notification - // content view. + // The URL of the large icon image to display in the content view of the push + // notification. ImageIconUrl *string `type:"string"` - // The URL that points to an image used in the push notification. + // The URL of an image to display in the push notification. ImageUrl *string `type:"string"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the notification + // message. This value overrides the message. RawContent *string `type:"string"` - // Indicates if the message should display on the users device. Silent pushes - // can be used for Remote Configuration and Phone Home use cases. + // Specifies whether the notification is a silent push notification, which is + // a push notification that doesn't display on a recipient's device. Silent + // push notifications can be used for cases such as updating an app's configuration + // or supporting phone home functionality. SilentPush *bool `type:"boolean"` - // The URL that points to an image used as the small icon for the notification - // which will be used to represent the notification in the status bar and content - // view + // The URL of the small icon image to display in the status bar and the content + // view of the push notification. SmallImageIconUrl *string `type:"string"` - // Indicates a sound to play when the device receives the notification. Supports - // default, or the filename of a sound resource bundled in the app. Android - // sound files must reside in /res/raw/ + // The sound to play when the recipient receives the push notification. You + // can use the default stream or specify the file name of a sound resource that's + // bundled in your app. On an Android platform, the sound file must reside in + // /res/raw/. Sound *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the notification message. You can + // override the default variables with individual address variables. Substitutions map[string][]*string `type:"map"` - // This parameter specifies how long (in seconds) the message should be kept - // in Baidu storage if the device is offline. The and the default value and - // the maximum time to live supported is 7 days (604800 seconds) + // The amount of time, in seconds, that the Baidu Cloud Push service should + // store the message if the recipient's device is offline. The default value + // and maximum supported time is 604,800 seconds (7 days). TimeToLive *int64 `type:"integer"` - // The message title that displays above the message on the user's device. + // The title to display above the notification message on the recipient's device. Title *string `type:"string"` - // The URL to open in the user's mobile browser. Used if the value for Action - // is URL. + // The URL to open in the recipient's default mobile browser, if a recipient + // taps the push notification and the value of the Action property is URL. Url *string `type:"string"` } @@ -9358,22 +9639,27 @@ func (s *BaiduMessage) SetUrl(v string) *BaiduMessage { return s } -// The email message configuration. +// Specifies the content and "From" address for an email message that's sent +// to recipients of a campaign. type CampaignEmailMessage struct { _ struct{} `type:"structure"` - // The email text body. + // The body of the email for recipients whose email clients don't support HTML + // content. Body *string `type:"string"` - // The email address used to send the email from. Defaults to use FromAddress - // specified in the Email Channel. + // The verified email address to send the email from. The default address is + // the FromAddress specified for the email channel for the application. FromAddress *string `type:"string"` - // The email html body. + // The body of the email, in HTML format, for recipients whose email clients + // support HTML content. HtmlBody *string `type:"string"` - // The email title (Or subject). - Title *string `type:"string"` + // The subject line, or title, of the email. + // + // Title is a required field + Title *string `type:"string" required:"true"` } // String returns the string representation @@ -9386,6 +9672,19 @@ func (s CampaignEmailMessage) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *CampaignEmailMessage) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CampaignEmailMessage"} + if s.Title == nil { + invalidParams.Add(request.NewErrParamRequired("Title")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetBody sets the Body field's value. func (s *CampaignEmailMessage) SetBody(v string) *CampaignEmailMessage { s.Body = &v @@ -9410,18 +9709,21 @@ func (s *CampaignEmailMessage) SetTitle(v string) *CampaignEmailMessage { return s } -// An object that defines the events that cause the campaign to be sent. +// Specifies the settings for events that cause a campaign to be sent. type CampaignEventFilter struct { _ struct{} `type:"structure"` - // An object that defines the dimensions for the event filter. - Dimensions *EventDimensions `type:"structure"` + // The dimension settings of the event filter for the campaign. + // + // Dimensions is a required field + Dimensions *EventDimensions `type:"structure" required:"true"` - // The type of event that causes the campaign to be sent. Possible values:SYSTEM - // - Send the campaign when a system event occurs. See the System resource for - // more information.ENDPOINT - Send the campaign when an endpoint event occurs. - // See the Event resource for more information. - FilterType *string `type:"string" enum:"FilterType"` + // The type of event that causes the campaign to be sent. Valid values are: + // SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends + // the campaign when an endpoint event (Events resource) occurs. + // + // FilterType is a required field + FilterType *string `type:"string" required:"true" enum:"FilterType"` } // String returns the string representation @@ -9434,6 +9736,27 @@ func (s CampaignEventFilter) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *CampaignEventFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CampaignEventFilter"} + if s.Dimensions == nil { + invalidParams.Add(request.NewErrParamRequired("Dimensions")) + } + if s.FilterType == nil { + invalidParams.Add(request.NewErrParamRequired("FilterType")) + } + if s.Dimensions != nil { + if err := s.Dimensions.Validate(); err != nil { + invalidParams.AddNested("Dimensions", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDimensions sets the Dimensions field's value. func (s *CampaignEventFilter) SetDimensions(v *EventDimensions) *CampaignEventFilter { s.Dimensions = v @@ -9446,18 +9769,19 @@ func (s *CampaignEventFilter) SetFilterType(v string) *CampaignEventFilter { return s } -// Campaign hook information. +// Specifies the AWS Lambda function to use as a code hook for a campaign. type CampaignHook struct { _ struct{} `type:"structure"` - // Lambda function name or arn to be called for delivery + // The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon + // Pinpoint invokes to send messages for a campaign. LambdaFunctionName *string `type:"string"` - // What mode Lambda should be invoked in. + // Specifies which Lambda mode to use when invoking the AWS Lambda function. Mode *string `type:"string" enum:"Mode"` - // Web URL to call for hook. If the URL has authentication specified it will - // be added as authentication to the request + // The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function + // over HTTPS. WebUrl *string `type:"string"` } @@ -9489,26 +9813,25 @@ func (s *CampaignHook) SetWebUrl(v string) *CampaignHook { return s } -// Campaign Limits are used to limit the number of messages that can be sent -// to a single endpoint. +// Specifies limits on the messages that a campaign can send. type CampaignLimits struct { _ struct{} `type:"structure"` - // The maximum number of messages that each campaign can send to a single endpoint - // in a 24-hour period. + // The maximum number of messages that a campaign can send to a single endpoint + // during a 24-hour period. The maximum value is 100. Daily *int64 `type:"integer"` - // The length of time (in seconds) that the campaign can run before it ends - // and message deliveries stop. This duration begins at the scheduled start - // time for the campaign. The minimum value is 60. + // The maximum amount of time, in seconds, that a campaign can attempt to deliver + // a message after the scheduled start time for the campaign. The minimum value + // is 60 seconds. MaximumDuration *int64 `type:"integer"` - // The number of messages that the campaign can send per second. The minimum - // value is 50, and the maximum is 20000. + // The maximum number of messages that a campaign can send each second. The + // minimum value is 50. The maximum value is 20,000. MessagesPerSecond *int64 `type:"integer"` - // The maximum number of messages that an individual campaign can send to a - // single endpoint over the course of the campaign. + // The maximum number of messages that a campaign can send to a single endpoint + // during the course of the campaign. The maximum value is 100. Total *int64 `type:"integer"` } @@ -9546,78 +9869,96 @@ func (s *CampaignLimits) SetTotal(v int64) *CampaignLimits { return s } -// Campaign definition +// Provides information about the status, configuration, and other settings +// for a campaign. type CampaignResponse struct { _ struct{} `type:"structure"` - // Treatments that are defined in addition to the default treatment. + // An array of responses, one for each treatment that you defined for the campaign, + // in addition to the default treatment. AdditionalTreatments []*TreatmentResource `type:"list"` - // The ID of the application to which the campaign applies. - ApplicationId *string `type:"string"` + // The unique identifier for the application that the campaign applies to. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The arn for the campaign. - Arn *string `type:"string"` + // The Amazon Resource Name (ARN) of the campaign. + // + // Arn is a required field + Arn *string `type:"string" required:"true"` - // The date the campaign was created in ISO 8601 format. - CreationDate *string `type:"string"` + // The date, ISO 8601 format, when the campaign was created. + // + // CreationDate is a required field + CreationDate *string `type:"string" required:"true"` - // The status of the campaign's default treatment. Only present for A/B test - // campaigns. + // The current status of the campaign's default treatment. This value exists + // only for campaigns that have more than one treatment, to support A/B testing. DefaultState *CampaignState `type:"structure"` - // A description of the campaign. + // The custom description of the campaign. Description *string `type:"string"` - // The allocated percentage of end users who will not receive messages from - // this campaign. + // The allocated percentage of users (segment members) who shouldn't receive + // messages from the campaign. HoldoutPercent *int64 `type:"integer"` - // Campaign hook information. + // The settings for the AWS Lambda function to use as a code hook for the campaign. Hook *CampaignHook `type:"structure"` - // The unique campaign ID. - Id *string `type:"string"` + // The unique identifier for the campaign. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // Indicates whether the campaign is paused. A paused campaign does not send - // messages unless you resume it by setting IsPaused to false. + // Specifies whether the campaign is paused. A paused campaign doesn't run unless + // you resume it by changing this value to false. IsPaused *bool `type:"boolean"` - // The date the campaign was last updated in ISO 8601 format. - LastModifiedDate *string `type:"string"` + // The date, in ISO 8601 format, when the campaign was last modified. + // + // LastModifiedDate is a required field + LastModifiedDate *string `type:"string" required:"true"` - // The campaign limits settings. + // The messaging limits for the campaign. Limits *CampaignLimits `type:"structure"` - // The message configuration settings. + // The message configuration settings for the campaign. MessageConfiguration *MessageConfiguration `type:"structure"` - // The custom name of the campaign. + // The name of the campaign. Name *string `type:"string"` - // The campaign schedule. + // The schedule settings for the campaign. Schedule *Schedule `type:"structure"` - // The ID of the segment to which the campaign sends messages. - SegmentId *string `type:"string"` + // The unique identifier for the segment that's associated with the campaign. + // + // SegmentId is a required field + SegmentId *string `type:"string" required:"true"` - // The version of the segment to which the campaign sends messages. - SegmentVersion *int64 `type:"integer"` + // The version number of the segment that's associated with the campaign. + // + // SegmentVersion is a required field + SegmentVersion *int64 `type:"integer" required:"true"` - // The campaign status.An A/B test campaign will have a status of COMPLETED - // only when all treatments have a status of COMPLETED. + // The current status of the campaign. State *CampaignState `type:"structure"` - // The Tags for the campaign. + // A string-to-string map of key-value pairs that identifies the tags that are + // associated with the campaign. Each tag consists of a required tag key and + // an associated tag value. Tags map[string]*string `locationName:"tags" type:"map"` - // A custom description for the treatment. + // The custom description of a variation of the campaign that's used for A/B + // testing. TreatmentDescription *string `type:"string"` - // The custom name of a variation of the campaign used for A/B testing. + // The custom name of a variation of the campaign that's used for A/B testing. TreatmentName *string `type:"string"` - // The campaign version number. + // The version number of the campaign. Version *int64 `type:"integer"` } @@ -9763,17 +10104,22 @@ func (s *CampaignResponse) SetVersion(v int64) *CampaignResponse { return s } -// SMS message configuration. +// Specifies the content and settings for an SMS message that's sent to recipients +// of a campaign. type CampaignSmsMessage struct { _ struct{} `type:"structure"` - // The SMS text body. + // The body of the SMS message. Body *string `type:"string"` - // Is this is a transactional SMS message, otherwise a promotional message. + // The type of SMS message. Valid values are: TRANSACTIONAL, the message is + // critical or time-sensitive, such as a one-time password that supports a customer + // transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, + // such as a marketing message. MessageType *string `type:"string" enum:"MessageType"` - // Sender ID of sent message. + // The sender ID to display on recipients' devices when they receive the SMS + // message. SenderId *string `type:"string"` } @@ -9805,13 +10151,13 @@ func (s *CampaignSmsMessage) SetSenderId(v string) *CampaignSmsMessage { return s } -// State of the Campaign +// Provides information about the status of a campaign. type CampaignState struct { _ struct{} `type:"structure"` // The status of the campaign, or the status of a treatment that belongs to - // an A/B test campaign.Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, - // COMPLETED, PAUSED + // an A/B test campaign. If a campaign uses A/B testing, the campaign has a + // status of COMPLETED only when all campaign treatments have a status of COMPLETED. CampaignStatus *string `type:"string" enum:"CampaignStatus"` } @@ -9831,15 +10177,18 @@ func (s *CampaignState) SetCampaignStatus(v string) *CampaignState { return s } -// List of available campaigns. +// Provides information about the configuration and other settings for all the +// campaigns that are associated with an application. type CampaignsResponse struct { _ struct{} `type:"structure"` - // A list of campaigns. - Item []*CampaignResponse `type:"list"` + // An array of responses, one for each campaign that's associated with the application. + // + // Item is a required field + Item []*CampaignResponse `type:"list" required:"true"` - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. + // The string to use in a subsequent request to get the next page of results + // in a paginated response. This value is null if there are no additional pages. NextToken *string `type:"string"` } @@ -9865,35 +10214,37 @@ func (s *CampaignsResponse) SetNextToken(v string) *CampaignsResponse { return s } -// Base definition for channel response. +// Provides information about the general settings and status of a channel for +// an application. type ChannelResponse struct { _ struct{} `type:"structure"` - // Application id + // The unique identifier for the application. ApplicationId *string `type:"string"` - // When was this segment created + // The date and time, in ISO 8601 format, when the channel was enabled. CreationDate *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the channel. This property is retained only + // for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the channel is archived. IsArchived *bool `type:"boolean"` - // Who made the last change + // The user who last modified the channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time, in ISO 8601 format, when the channel was last modified. LastModifiedDate *string `type:"string"` - // Version of channel + // The current version of the channel. Version *int64 `type:"integer"` } @@ -9961,13 +10312,16 @@ func (s *ChannelResponse) SetVersion(v int64) *ChannelResponse { return s } -// Get channels definition +// Provides information about the general settings and status of all channels +// for an application, including channels that aren't enabled for the application. type ChannelsResponse struct { _ struct{} `type:"structure"` - // A map of channels, with the ChannelType as the key and the Channel as the - // value. - Channels map[string]*ChannelResponse `type:"map"` + // A map that contains a multipart response for each channel. For each item + // in this object, the ChannelType is the key and the Channel is the value. + // + // Channels is a required field + Channels map[string]*ChannelResponse `type:"map" required:"true"` } // String returns the string representation @@ -9989,7 +10343,8 @@ func (s *ChannelsResponse) SetChannels(v map[string]*ChannelResponse) *ChannelsR type CreateAppInput struct { _ struct{} `type:"structure" payload:"CreateApplicationRequest"` - // Application Request. + // Specifies the display name of an application and the tags to associate with + // the application. // // CreateApplicationRequest is a required field CreateApplicationRequest *CreateApplicationRequest `type:"structure" required:"true"` @@ -10011,6 +10366,11 @@ func (s *CreateAppInput) Validate() error { if s.CreateApplicationRequest == nil { invalidParams.Add(request.NewErrParamRequired("CreateApplicationRequest")) } + if s.CreateApplicationRequest != nil { + if err := s.CreateApplicationRequest.Validate(); err != nil { + invalidParams.AddNested("CreateApplicationRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10027,7 +10387,7 @@ func (s *CreateAppInput) SetCreateApplicationRequest(v *CreateApplicationRequest type CreateAppOutput struct { _ struct{} `type:"structure" payload:"ApplicationResponse"` - // Application Response. + // Provides information about an application. // // ApplicationResponse is a required field ApplicationResponse *ApplicationResponse `type:"structure" required:"true"` @@ -10049,14 +10409,20 @@ func (s *CreateAppOutput) SetApplicationResponse(v *ApplicationResponse) *Create return s } -// Application Request. +// Specifies the display name of an application and the tags to associate with +// the application. type CreateApplicationRequest struct { _ struct{} `type:"structure"` - // The display name of the application. Used in the Amazon Pinpoint console. - Name *string `type:"string"` + // The display name of the application. This name is displayed as the Project + // name on the Amazon Pinpoint console. + // + // Name is a required field + Name *string `type:"string" required:"true"` - // The Tags for the app. + // A string-to-string map of key-value pairs that defines the tags to associate + // with the application. Each tag consists of a required tag key and an associated + // tag value. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -10070,6 +10436,19 @@ func (s CreateApplicationRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateApplicationRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateApplicationRequest"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetName sets the Name field's value. func (s *CreateApplicationRequest) SetName(v string) *CreateApplicationRequest { s.Name = &v @@ -10088,7 +10467,7 @@ type CreateCampaignInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Used to create a campaign. + // Specifies the configuration and other settings for a campaign. // // WriteCampaignRequest is a required field WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"` @@ -10116,6 +10495,11 @@ func (s *CreateCampaignInput) Validate() error { if s.WriteCampaignRequest == nil { invalidParams.Add(request.NewErrParamRequired("WriteCampaignRequest")) } + if s.WriteCampaignRequest != nil { + if err := s.WriteCampaignRequest.Validate(); err != nil { + invalidParams.AddNested("WriteCampaignRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10138,7 +10522,8 @@ func (s *CreateCampaignInput) SetWriteCampaignRequest(v *WriteCampaignRequest) * type CreateCampaignOutput struct { _ struct{} `type:"structure" payload:"CampaignResponse"` - // Campaign definition + // Provides information about the status, configuration, and other settings + // for a campaign. // // CampaignResponse is a required field CampaignResponse *CampaignResponse `type:"structure" required:"true"` @@ -10166,7 +10551,8 @@ type CreateExportJobInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Export job request. + // Specifies the settings for a job that exports endpoint definitions to an + // Amazon Simple Storage Service (Amazon S3) bucket. // // ExportJobRequest is a required field ExportJobRequest *ExportJobRequest `type:"structure" required:"true"` @@ -10194,6 +10580,11 @@ func (s *CreateExportJobInput) Validate() error { if s.ExportJobRequest == nil { invalidParams.Add(request.NewErrParamRequired("ExportJobRequest")) } + if s.ExportJobRequest != nil { + if err := s.ExportJobRequest.Validate(); err != nil { + invalidParams.AddNested("ExportJobRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10216,7 +10607,10 @@ func (s *CreateExportJobInput) SetExportJobRequest(v *ExportJobRequest) *CreateE type CreateExportJobOutput struct { _ struct{} `type:"structure" payload:"ExportJobResponse"` - // Export job response. + // Provides information about the status and settings of a job that exports + // endpoint definitions to a file. The file can be added directly to an Amazon + // Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API + // or downloaded directly to a computer by using the Amazon Pinpoint console. // // ExportJobResponse is a required field ExportJobResponse *ExportJobResponse `type:"structure" required:"true"` @@ -10244,7 +10638,8 @@ type CreateImportJobInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Import job request. + // Specifies the settings for a job that imports endpoint definitions from an + // Amazon Simple Storage Service (Amazon S3) bucket. // // ImportJobRequest is a required field ImportJobRequest *ImportJobRequest `type:"structure" required:"true"` @@ -10272,6 +10667,11 @@ func (s *CreateImportJobInput) Validate() error { if s.ImportJobRequest == nil { invalidParams.Add(request.NewErrParamRequired("ImportJobRequest")) } + if s.ImportJobRequest != nil { + if err := s.ImportJobRequest.Validate(); err != nil { + invalidParams.AddNested("ImportJobRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10294,7 +10694,10 @@ func (s *CreateImportJobInput) SetImportJobRequest(v *ImportJobRequest) *CreateI type CreateImportJobOutput struct { _ struct{} `type:"structure" payload:"ImportJobResponse"` - // Import job response. + // Provides information about the status and settings of a job that imports + // endpoint definitions from one or more files. The files can be stored in an + // Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from + // a computer by using the Amazon Pinpoint console. // // ImportJobResponse is a required field ImportJobResponse *ImportJobResponse `type:"structure" required:"true"` @@ -10322,7 +10725,9 @@ type CreateSegmentInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Segment definition. + // Specifies the configuration, dimension, and other settings for a segment. + // A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups + // object, but not both. // // WriteSegmentRequest is a required field WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"` @@ -10350,6 +10755,11 @@ func (s *CreateSegmentInput) Validate() error { if s.WriteSegmentRequest == nil { invalidParams.Add(request.NewErrParamRequired("WriteSegmentRequest")) } + if s.WriteSegmentRequest != nil { + if err := s.WriteSegmentRequest.Validate(); err != nil { + invalidParams.AddNested("WriteSegmentRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10372,7 +10782,8 @@ func (s *CreateSegmentInput) SetWriteSegmentRequest(v *WriteSegmentRequest) *Cre type CreateSegmentOutput struct { _ struct{} `type:"structure" payload:"SegmentResponse"` - // Segment definition. + // Provides information about the configuration, dimension, and other settings + // for a segment. // // SegmentResponse is a required field SegmentResponse *SegmentResponse `type:"structure" required:"true"` @@ -10394,14 +10805,16 @@ func (s *CreateSegmentOutput) SetSegmentResponse(v *SegmentResponse) *CreateSegm return s } -// The default message to use across all channels. +// Specifies the default message to use for all channels. type DefaultMessage struct { _ struct{} `type:"structure"` - // The message body of the notification, the email body or the text message. + // The default message body of the push notification, email, or SMS message. Body *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the push notification, email, or + // SMS message. You can override these default variables with individual address + // variables. Substitutions map[string][]*string `type:"map"` } @@ -10427,39 +10840,49 @@ func (s *DefaultMessage) SetSubstitutions(v map[string][]*string) *DefaultMessag return s } -// Default Push Notification Message. +// Specifies the default settings and content for a push notification that's +// sent directly to an endpoint. type DefaultPushNotificationMessage struct { _ struct{} `type:"structure"` - // The action that occurs if the user taps a push notification delivered by - // the campaign: OPEN_APP - Your app launches, or it becomes the foreground - // app if it has been sent to the background. This is the default action. DEEP_LINK - // - Uses deep linking features in iOS and Android to open your app and display - // a designated user interface within the app. URL - The default mobile browser - // on the user's device launches and opens a web page at the URL you specify. - // Possible values include: OPEN_APP | DEEP_LINK | URL + // The default action to occur if a recipient taps the push notification. Valid + // values are: + // + // * OPEN_APP - Your app opens or it becomes the foreground app if it was + // sent to the background. This is the default action. + // + // * DEEP_LINK - Your app opens and displays a designated user interface + // in the app. This setting uses the deep-linking features of the iOS and + // Android platforms. + // + // * URL - The default mobile browser on the recipient's device opens and + // loads the web page at a URL that you specify. Action *string `type:"string" enum:"Action"` - // The message body of the notification. + // The default body of the notification message. Body *string `type:"string"` - // The data payload used for a silent push. This payload is added to the notifications' - // data.pinpoint.jsonBody' object + // The JSON data payload to use for the default push notification, if the notification + // is a silent push notification. This payload is added to the data.pinpoint.jsonBody + // object of the notification. Data map[string]*string `type:"map"` - // Indicates if the message should display on the recipient's device. You can - // use silent pushes for remote configuration or to deliver messages to in-app - // notification centers. + // Specifies whether the default notification is a silent push notification, + // which is a push notification that doesn't display on a recipient's device. + // Silent push notifications can be used for cases such as updating an app's + // configuration or delivering messages to an in-app notification center. SilentPush *bool `type:"boolean"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the notification message. You can + // override the default variables with individual address variables. Substitutions map[string][]*string `type:"map"` - // The message title that displays above the message on the user's device. + // The default title to display above the notification message on a recipient's + // device. Title *string `type:"string"` - // The URL to open in the user's mobile browser. Used if the value for Action - // is URL. + // The default URL to open in a recipient's default mobile browser, if a recipient + // taps the push notification and the value of the Action property is URL. Url *string `type:"string"` } @@ -10557,7 +10980,8 @@ func (s *DeleteAdmChannelInput) SetApplicationId(v string) *DeleteAdmChannelInpu type DeleteAdmChannelOutput struct { _ struct{} `type:"structure" payload:"ADMChannelResponse"` - // Amazon Device Messaging channel definition. + // Provides information about the status and settings of the ADM (Amazon Device + // Messaging) channel for an application. // // ADMChannelResponse is a required field ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"` @@ -10621,7 +11045,8 @@ func (s *DeleteApnsChannelInput) SetApplicationId(v string) *DeleteApnsChannelIn type DeleteApnsChannelOutput struct { _ struct{} `type:"structure" payload:"APNSChannelResponse"` - // Apple Distribution Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) channel for an application. // // APNSChannelResponse is a required field APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"` @@ -10685,7 +11110,8 @@ func (s *DeleteApnsSandboxChannelInput) SetApplicationId(v string) *DeleteApnsSa type DeleteApnsSandboxChannelOutput struct { _ struct{} `type:"structure" payload:"APNSSandboxChannelResponse"` - // Apple Development Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) sandbox channel for an application. // // APNSSandboxChannelResponse is a required field APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"` @@ -10749,7 +11175,8 @@ func (s *DeleteApnsVoipChannelInput) SetApplicationId(v string) *DeleteApnsVoipC type DeleteApnsVoipChannelOutput struct { _ struct{} `type:"structure" payload:"APNSVoipChannelResponse"` - // Apple VoIP Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) VoIP channel for an application. // // APNSVoipChannelResponse is a required field APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"` @@ -10813,7 +11240,8 @@ func (s *DeleteApnsVoipSandboxChannelInput) SetApplicationId(v string) *DeleteAp type DeleteApnsVoipSandboxChannelOutput struct { _ struct{} `type:"structure" payload:"APNSVoipSandboxChannelResponse"` - // Apple VoIP Developer Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) VoIP sandbox channel for an application. // // APNSVoipSandboxChannelResponse is a required field APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"` @@ -10877,7 +11305,7 @@ func (s *DeleteAppInput) SetApplicationId(v string) *DeleteAppInput { type DeleteAppOutput struct { _ struct{} `type:"structure" payload:"ApplicationResponse"` - // Application Response. + // Provides information about an application. // // ApplicationResponse is a required field ApplicationResponse *ApplicationResponse `type:"structure" required:"true"` @@ -10941,7 +11369,8 @@ func (s *DeleteBaiduChannelInput) SetApplicationId(v string) *DeleteBaiduChannel type DeleteBaiduChannelOutput struct { _ struct{} `type:"structure" payload:"BaiduChannelResponse"` - // Baidu Cloud Messaging channel definition + // Provides information about the status and settings of the Baidu (Baidu Cloud + // Push) channel for an application. // // BaiduChannelResponse is a required field BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"` @@ -11020,7 +11449,8 @@ func (s *DeleteCampaignInput) SetCampaignId(v string) *DeleteCampaignInput { type DeleteCampaignOutput struct { _ struct{} `type:"structure" payload:"CampaignResponse"` - // Campaign definition + // Provides information about the status, configuration, and other settings + // for a campaign. // // CampaignResponse is a required field CampaignResponse *CampaignResponse `type:"structure" required:"true"` @@ -11084,7 +11514,8 @@ func (s *DeleteEmailChannelInput) SetApplicationId(v string) *DeleteEmailChannel type DeleteEmailChannelOutput struct { _ struct{} `type:"structure" payload:"EmailChannelResponse"` - // Email Channel Response. + // Provides information about the status and settings of the email channel for + // an application. // // EmailChannelResponse is a required field EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"` @@ -11163,7 +11594,7 @@ func (s *DeleteEndpointInput) SetEndpointId(v string) *DeleteEndpointInput { type DeleteEndpointOutput struct { _ struct{} `type:"structure" payload:"EndpointResponse"` - // Endpoint response + // Provides information about the channel type and other settings for an endpoint. // // EndpointResponse is a required field EndpointResponse *EndpointResponse `type:"structure" required:"true"` @@ -11227,7 +11658,8 @@ func (s *DeleteEventStreamInput) SetApplicationId(v string) *DeleteEventStreamIn type DeleteEventStreamOutput struct { _ struct{} `type:"structure" payload:"EventStream"` - // Model for an event publishing subscription export. + // Specifies settings for publishing event data to an Amazon Kinesis data stream + // or an Amazon Kinesis Data Firehose delivery stream. // // EventStream is a required field EventStream *EventStream `type:"structure" required:"true"` @@ -11291,7 +11723,10 @@ func (s *DeleteGcmChannelInput) SetApplicationId(v string) *DeleteGcmChannelInpu type DeleteGcmChannelOutput struct { _ struct{} `type:"structure" payload:"GCMChannelResponse"` - // Google Cloud Messaging channel definition + // Provides information about the status and settings of the GCM channel for + // an application. The GCM channel enables Amazon Pinpoint to send push notifications + // through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging + // (GCM), service. // // GCMChannelResponse is a required field GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"` @@ -11370,7 +11805,8 @@ func (s *DeleteSegmentInput) SetSegmentId(v string) *DeleteSegmentInput { type DeleteSegmentOutput struct { _ struct{} `type:"structure" payload:"SegmentResponse"` - // Segment definition. + // Provides information about the configuration, dimension, and other settings + // for a segment. // // SegmentResponse is a required field SegmentResponse *SegmentResponse `type:"structure" required:"true"` @@ -11434,7 +11870,8 @@ func (s *DeleteSmsChannelInput) SetApplicationId(v string) *DeleteSmsChannelInpu type DeleteSmsChannelOutput struct { _ struct{} `type:"structure" payload:"SMSChannelResponse"` - // SMS Channel Response. + // Provides information about the status and settings of the SMS channel for + // an application. // // SMSChannelResponse is a required field SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"` @@ -11513,7 +11950,8 @@ func (s *DeleteUserEndpointsInput) SetUserId(v string) *DeleteUserEndpointsInput type DeleteUserEndpointsOutput struct { _ struct{} `type:"structure" payload:"EndpointsResponse"` - // List of endpoints + // Provides information about all the endpoints that are associated with a user + // ID. // // EndpointsResponse is a required field EndpointsResponse *EndpointsResponse `type:"structure" required:"true"` @@ -11577,7 +12015,8 @@ func (s *DeleteVoiceChannelInput) SetApplicationId(v string) *DeleteVoiceChannel type DeleteVoiceChannelOutput struct { _ struct{} `type:"structure" payload:"VoiceChannelResponse"` - // Voice Channel Response. + // Provides information about the status and settings of the voice channel for + // an application. // // VoiceChannelResponse is a required field VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"` @@ -11599,37 +12038,46 @@ func (s *DeleteVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelRespon return s } -// Message definitions for the default message and any messages that are tailored -// for specific channels. +// Specifies the settings and content for the default message and any default +// messages that you tailored for specific channels. type DirectMessageConfiguration struct { _ struct{} `type:"structure"` - // The message to ADM channels. Overrides the default push notification message. + // The default push notification message for the ADM (Amazon Device Messaging) + // channel. This message overrides the default push notification message (DefaultPushNotificationMessage). ADMMessage *ADMMessage `type:"structure"` - // The message to APNS channels. Overrides the default push notification message. + // The default push notification message for the APNs (Apple Push Notification + // service) channel. This message overrides the default push notification message + // (DefaultPushNotificationMessage). APNSMessage *APNSMessage `type:"structure"` - // The message to Baidu GCM channels. Overrides the default push notification - // message. + // The default push notification message for the Baidu (Baidu Cloud Push) channel. + // This message overrides the default push notification message (DefaultPushNotificationMessage). BaiduMessage *BaiduMessage `type:"structure"` - // The default message for all channels. + // The default message body for all channels. DefaultMessage *DefaultMessage `type:"structure"` // The default push notification message for all push channels. DefaultPushNotificationMessage *DefaultPushNotificationMessage `type:"structure"` - // The message to Email channels. Overrides the default message. + // The default message for the email channel. This message overrides the default + // message (DefaultMessage). EmailMessage *EmailMessage `type:"structure"` - // The message to GCM channels. Overrides the default push notification message. + // The default push notification message for the GCM channel, which is used + // to send notifications through the Firebase Cloud Messaging (FCM), formerly + // Google Cloud Messaging (GCM), service. This message overrides the default + // push notification message (DefaultPushNotificationMessage). GCMMessage *GCMMessage `type:"structure"` - // The message to SMS channels. Overrides the default message. + // The default message for the SMS channel. This message overrides the default + // message (DefaultMessage). SMSMessage *SMSMessage `type:"structure"` - // The message to Voice channels. Overrides the default message. + // The default message for the voice channel. This message overrides the default + // message (DefaultMessage). VoiceMessage *VoiceMessage `type:"structure"` } @@ -11697,25 +12145,32 @@ func (s *DirectMessageConfiguration) SetVoiceMessage(v *VoiceMessage) *DirectMes return s } -// Email Channel Request +// Specifies the status and settings of the email channel for an application. type EmailChannelRequest struct { _ struct{} `type:"structure"` - // The configuration set that you want to use when you send email using the - // Pinpoint Email API. + // The configuration set that you want to apply to email that you send through + // the channel by using the Amazon Pinpoint Email API (emailAPIreference.html). ConfigurationSet *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the email channel for the application. Enabled *bool `type:"boolean"` - // The email address used to send emails from. - FromAddress *string `type:"string"` + // The verified email address that you want to send email from when you send + // email through the channel. + // + // FromAddress is a required field + FromAddress *string `type:"string" required:"true"` - // The ARN of an identity verified with SES. - Identity *string `type:"string"` + // The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple + // Email Service (Amazon SES), that you want to use when you send email through + // the channel. + // + // Identity is a required field + Identity *string `type:"string" required:"true"` - // The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion - // service + // The ARN of the AWS Identity and Access Management (IAM) role that you want + // Amazon Pinpoint to use when it submits email-related event data for the channel. RoleArn *string `type:"string"` } @@ -11729,6 +12184,22 @@ func (s EmailChannelRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *EmailChannelRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EmailChannelRequest"} + if s.FromAddress == nil { + invalidParams.Add(request.NewErrParamRequired("FromAddress")) + } + if s.Identity == nil { + invalidParams.Add(request.NewErrParamRequired("Identity")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetConfigurationSet sets the ConfigurationSet field's value. func (s *EmailChannelRequest) SetConfigurationSet(v string) *EmailChannelRequest { s.ConfigurationSet = &v @@ -11759,55 +12230,64 @@ func (s *EmailChannelRequest) SetRoleArn(v string) *EmailChannelRequest { return s } -// Email Channel Response. +// Provides information about the status and settings of the email channel for +// an application. type EmailChannelResponse struct { _ struct{} `type:"structure"` - // The unique ID of the application to which the email channel belongs. + // The unique identifier for the application that the email channel applies + // to. ApplicationId *string `type:"string"` - // The configuration set that you want to use when you send email using the - // Pinpoint Email API. + // The configuration set that's applied to email that's sent through the channel + // by using the Amazon Pinpoint Email API (emailAPIreference.html). ConfigurationSet *string `type:"string"` - // The date that the settings were last updated in ISO 8601 format. + // The date and time, in ISO 8601 format, when the email channel was enabled. CreationDate *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the email channel is enabled for the application. Enabled *bool `type:"boolean"` - // The email address used to send emails from. + // The verified email address that you send email from when you send email through + // the channel. FromAddress *string `type:"string"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the email channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // The ARN of an identity verified with SES. + // The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple + // Email Service (Amazon SES), that you use when you send email through the + // channel. Identity *string `type:"string"` - // Is this channel archived + // Specifies whether the email channel is archived. IsArchived *bool `type:"boolean"` - // Who last updated this entry + // The user who last modified the email channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time, in ISO 8601 format, when the email channel was last modified. LastModifiedDate *string `type:"string"` - // Messages per second that can be sent + // The maximum number of emails that you can send through the channel each second. MessagesPerSecond *int64 `type:"integer"` - // Platform type. Will be "EMAIL" - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the email + // channel, this value is EMAIL. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion - // service + // The ARN of the AWS Identity and Access Management (IAM) role that Amazon + // Pinpoint uses to submit email-related event data for the channel. RoleArn *string `type:"string"` - // Version of channel + // The current version of the email channel. Version *int64 `type:"integer"` } @@ -11911,32 +12391,34 @@ func (s *EmailChannelResponse) SetVersion(v int64) *EmailChannelResponse { return s } -// Email Message. +// Specifies the default settings and content for a one-time email message that's +// sent directly to an endpoint. type EmailMessage struct { _ struct{} `type:"structure"` // The body of the email message. Body *string `type:"string"` - // The email address that bounces and complaints will be forwarded to when feedback - // forwarding is enabled. + // The email address to forward bounces and complaints to, if feedback forwarding + // is enabled. FeedbackForwardingAddress *string `type:"string"` - // The email address used to send the email from. Defaults to use FromAddress - // specified in the Email Channel. + // The verified email address to send the email message from. The default value + // is the FromAddress specified for the email channel. FromAddress *string `type:"string"` - // An email represented as a raw MIME message. + // The email message, represented as a raw MIME message. RawEmail *RawEmail `type:"structure"` - // The reply-to email address(es) for the email. If the recipient replies to - // the email, each reply-to address will receive the reply. + // The reply-to email address(es) for the email message. If a recipient replies + // to the email, each reply-to address receives the reply. ReplyToAddresses []*string `type:"list"` - // An email composed of a subject, a text part and a html part. + // The email message, composed of a subject, a text part, and an HTML part. SimpleEmail *SimpleEmail `type:"structure"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the email message. You can override + // the default variables with individual address variables. Substitutions map[string][]*string `type:"map"` } @@ -11992,58 +12474,65 @@ func (s *EmailMessage) SetSubstitutions(v map[string][]*string) *EmailMessage { return s } -// Endpoint update request +// Specifies an endpoint to create or update and the settings and attributes +// to set or change for the endpoint. type EndpointBatchItem struct { _ struct{} `type:"structure"` - // The destination for messages that you send to this endpoint. The address - // varies by channel. For mobile push channels, use the token provided by the - // push notification service, such as the APNs device token or the FCM registration - // token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. - // For the email channel, use an email address. + // The destination address for messages or push notifications that you send + // to the endpoint. The address varies by channel. For a push-notification channel, + // use the token provided by the push notification service, such as an Apple + // Push Notification service (APNs) device token or a Firebase Cloud Messaging + // (FCM) registration token. For the SMS channel, use a phone number in E.164 + // format, such as +12065550100. For the email channel, use an email address. Address *string `type:"string"` - // Custom attributes that describe the endpoint by associating a name with an - // array of values. For example, an attribute named "interests" might have the - // values ["science", "politics", "travel"]. You can use these attributes as - // selection criteria when you create a segment of users to engage with a messaging - // campaign.The following characters are not recommended in attribute names: - // # : ? \ /. The Amazon Pinpoint console does not display attributes that include - // these characters in the name. This limitation does not apply to attribute + // One or more custom attributes that describe the endpoint by associating a + // name with an array of values. For example, the value of a custom attribute + // named Interests might be: ["science", "music", "travel"]. You can use these + // attributes as filter criteria when you create segments. + // + // When you define the name of a custom attribute, avoid using the following + // characters: number sign (#), colon (:), question mark (?), backslash (\), + // and slash (/). The Amazon Pinpoint console can't display attribute names + // that contain these characters. This limitation doesn't apply to attribute // values. Attributes map[string][]*string `type:"map"` - // The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX - // | ADM | SMS | EMAIL | BAIDU + // The channel to use when sending messages or push notifications to the endpoint. ChannelType *string `type:"string" enum:"ChannelType"` - // The endpoint demographic attributes. + // The demographic information for the endpoint, such as the time zone and platform. Demographic *EndpointDemographic `type:"structure"` - // The last time the endpoint was updated. Provided in ISO 8601 format. + // The date and time, in ISO 8601 format, when the endpoint was created or updated. EffectiveDate *string `type:"string"` - // Unused. + // Not used. EndpointStatus *string `type:"string"` - // The unique Id for the Endpoint in the batch. + // The unique identifier for the endpoint in the context of the batch. Id *string `type:"string"` - // The endpoint location attributes. + // The geographic information for the endpoint. Location *EndpointLocation `type:"structure"` - // Custom metrics that your app reports to Amazon Pinpoint. + // One or more custom metrics that your app reports to Amazon Pinpoint for the + // endpoint. Metrics map[string]*float64 `type:"map"` - // Indicates whether a user has opted out of receiving messages with one of - // the following values:ALL - User has opted out of all messages.NONE - Users - // has not opted out and receives all messages. + // Specifies whether the user who's associated with the endpoint has opted out + // of receiving messages and push notifications from you. Possible values are: + // ALL, the user has opted out and doesn't want to receive any messages or push + // notifications; and, NONE, the user hasn't opted out and wants to receive + // all messages and push notifications. OptOut *string `type:"string"` - // The unique ID for the most recent request to update the endpoint. + // The unique identifier for the request to create or update the endpoint. RequestId *string `type:"string"` - // Custom user-specific attributes that your app reports to Amazon Pinpoint. + // One or more custom user attributes that your app reports to Amazon Pinpoint + // for the user who's associated with the endpoint. User *EndpointUser `type:"structure"` } @@ -12129,12 +12618,17 @@ func (s *EndpointBatchItem) SetUser(v *EndpointUser) *EndpointBatchItem { return s } -// Endpoint batch update request. +// Specifies a batch of endpoints to create or update and the settings and attributes +// to set or change for each endpoint. type EndpointBatchRequest struct { _ struct{} `type:"structure"` - // List of items to update. Maximum 100 items - Item []*EndpointBatchItem `type:"list"` + // An array that defines the endpoints to create or update and, for each endpoint, + // the property values to set or change. An array can contain a maximum of 100 + // items. + // + // Item is a required field + Item []*EndpointBatchItem `type:"list" required:"true"` } // String returns the string representation @@ -12147,21 +12641,35 @@ func (s EndpointBatchRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *EndpointBatchRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EndpointBatchRequest"} + if s.Item == nil { + invalidParams.Add(request.NewErrParamRequired("Item")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetItem sets the Item field's value. func (s *EndpointBatchRequest) SetItem(v []*EndpointBatchItem) *EndpointBatchRequest { s.Item = v return s } -// Demographic information about the endpoint. +// Specifies demographic information about an endpoint, such as the applicable +// time zone and platform. type EndpointDemographic struct { _ struct{} `type:"structure"` - // The version of the application associated with the endpoint. + // The version of the app that's associated with the endpoint. AppVersion *string `type:"string"` - // The endpoint locale in the following format: The ISO 639-1 alpha-2 code, - // followed by an underscore, followed by an ISO 3166-1 alpha-2 value. + // The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 + // code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. Locale *string `type:"string"` // The manufacturer of the endpoint device, such as Apple or Samsung. @@ -12179,7 +12687,8 @@ type EndpointDemographic struct { // The platform version of the endpoint device. PlatformVersion *string `type:"string"` - // The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles. + // The time zone of the endpoint, specified as a tz database name value, such + // as America/Los_Angeles. Timezone *string `type:"string"` } @@ -12241,17 +12750,17 @@ func (s *EndpointDemographic) SetTimezone(v string) *EndpointDemographic { return s } -// A complex object that holds the status code and message as a result of processing +// Provides the status code and message that result from processing data for // an endpoint. type EndpointItemResponse struct { _ struct{} `type:"structure"` - // A custom message associated with the registration of an endpoint when issuing - // a response. + // The custom message that's returned in the response as a result of processing + // the endpoint data. Message *string `type:"string"` - // The status code associated with the merging of an endpoint when issuing a - // response. + // The status code that's returned in the response as a result of processing + // the endpoint data. StatusCode *int64 `type:"integer"` } @@ -12277,28 +12786,30 @@ func (s *EndpointItemResponse) SetStatusCode(v int64) *EndpointItemResponse { return s } -// Location data for the endpoint. +// Specifies geographic information about an endpoint. type EndpointLocation struct { _ struct{} `type:"structure"` - // The city where the endpoint is located. + // The name of the city where the endpoint is located. City *string `type:"string"` - // The two-letter code for the country or region of the endpoint. Specified - // as an ISO 3166-1 alpha-2 code, such as "US" for the United States. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region where the endpoint is located. For example, US for the United States. Country *string `type:"string"` - // The latitude of the endpoint location, rounded to one decimal place. + // The latitude coordinate of the endpoint location, rounded to one decimal + // place. Latitude *float64 `type:"double"` - // The longitude of the endpoint location, rounded to one decimal place. + // The longitude coordinate of the endpoint location, rounded to one decimal + // place. Longitude *float64 `type:"double"` - // The postal code or zip code of the endpoint. + // The postal or ZIP code for the area where the endpoint is located. PostalCode *string `type:"string"` - // The region of the endpoint location. For example, in the United States, this - // corresponds to a state. + // The name of the region where the endpoint is located. For locations in the + // United States, this value is the name of a state. Region *string `type:"string"` } @@ -12348,39 +12859,54 @@ func (s *EndpointLocation) SetRegion(v string) *EndpointLocation { return s } -// The result from sending a message to an endpoint. +// Provides information about the delivery status and results of sending a message +// directly to an endpoint. type EndpointMessageResult struct { _ struct{} `type:"structure"` - // Address that endpoint message was delivered to. + // The endpoint address that the message was delivered to. Address *string `type:"string"` - // The delivery status of the message. Possible values:SUCCESS - The message - // was successfully delivered to the endpoint.TRANSIENT_FAILURE - A temporary - // error occurred. Amazon Pinpoint will attempt to deliver the message again - // later.FAILURE_PERMANENT - An error occurred when delivering the message to - // the endpoint. Amazon Pinpoint won't attempt to send the message again.TIMEOUT - // - The message couldn't be sent within the timeout period.QUIET_TIME - The - // local time for the endpoint was within the QuietTime for the campaign or - // app.DAILY_CAP - The endpoint has received the maximum number of messages - // it can receive within a 24-hour period.HOLDOUT - The endpoint was in a hold - // out treatment for the campaign.THROTTLED - Amazon Pinpoint throttled sending - // to this endpoint.EXPIRED - The endpoint address is expired.CAMPAIGN_CAP - - // The endpoint received the maximum number of messages allowed by the campaign.SERVICE_FAILURE - // - A service-level failure prevented Amazon Pinpoint from delivering the message.UNKNOWN - // - An unknown error occurred. - DeliveryStatus *string `type:"string" enum:"DeliveryStatus"` - - // Unique message identifier associated with the message that was sent. + // The delivery status of the message. Possible values are: + // + // * DUPLICATE - The endpoint address is a duplicate of another endpoint + // address. Amazon Pinpoint won't attempt to send the message again. + // + // * OPT_OUT - The user who's associated with the endpoint has opted out + // of receiving messages from you. Amazon Pinpoint won't attempt to send + // the message again. + // + // * PERMANENT_FAILURE - An error occurred when delivering the message to + // the endpoint. Amazon Pinpoint won't attempt to send the message again. + // + // * SUCCESSFUL - The message was successfully delivered to the endpoint. + // + // * TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will + // attempt to deliver the message again later. + // + // * THROTTLED - Amazon Pinpoint throttled the operation to send the message + // to the endpoint. + // + // * TIMEOUT - The message couldn't be sent within the timeout period. + // + // * UNKNOWN_FAILURE - An unknown error occurred. + // + // DeliveryStatus is a required field + DeliveryStatus *string `type:"string" required:"true" enum:"DeliveryStatus"` + + // The unique identifier for the message that was sent. MessageId *string `type:"string"` - // Downstream service status code. - StatusCode *int64 `type:"integer"` + // The downstream service status code for delivering the message. + // + // StatusCode is a required field + StatusCode *int64 `type:"integer" required:"true"` - // Status message for message delivery. + // The status message for delivering the message. StatusMessage *string `type:"string"` - // If token was updated as part of delivery. (This is GCM Specific) + // For push notifications that are sent through the GCM channel, specifies whether + // the token was updated as part of delivering the message. UpdatedToken *string `type:"string"` } @@ -12430,55 +12956,61 @@ func (s *EndpointMessageResult) SetUpdatedToken(v string) *EndpointMessageResult return s } -// An endpoint update request. +// Specifies the channel type and other settings for an endpoint. type EndpointRequest struct { _ struct{} `type:"structure"` - // The destination for messages that you send to this endpoint. The address - // varies by channel. For mobile push channels, use the token provided by the - // push notification service, such as the APNs device token or the FCM registration - // token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. - // For the email channel, use an email address. + // The destination address for messages or push notifications that you send + // to the endpoint. The address varies by channel. For a push-notification channel, + // use the token provided by the push notification service, such as an Apple + // Push Notification service (APNs) device token or a Firebase Cloud Messaging + // (FCM) registration token. For the SMS channel, use a phone number in E.164 + // format, such as +12065550100. For the email channel, use an email address. Address *string `type:"string"` - // Custom attributes that describe the endpoint by associating a name with an - // array of values. For example, an attribute named "interests" might have the - // values ["science", "politics", "travel"]. You can use these attributes as - // selection criteria when you create a segment of users to engage with a messaging - // campaign.The following characters are not recommended in attribute names: - // # : ? \ /. The Amazon Pinpoint console does not display attributes that include - // these characters in the name. This limitation does not apply to attribute + // One or more custom attributes that describe the endpoint by associating a + // name with an array of values. For example, the value of a custom attribute + // named Interests might be: ["science", "music", "travel"]. You can use these + // attributes as filter criteria when you create segments. + // + // When you define the name of a custom attribute, avoid using the following + // characters: number sign (#), colon (:), question mark (?), backslash (\), + // and slash (/). The Amazon Pinpoint console can't display attribute names + // that contain these characters. This limitation doesn't apply to attribute // values. Attributes map[string][]*string `type:"map"` - // The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX - // | ADM | SMS | EMAIL | BAIDU + // The channel to use when sending messages or push notifications to the endpoint. ChannelType *string `type:"string" enum:"ChannelType"` - // Demographic attributes for the endpoint. + // The demographic information for the endpoint, such as the time zone and platform. Demographic *EndpointDemographic `type:"structure"` - // The date and time when the endpoint was updated, shown in ISO 8601 format. + // The date and time, in ISO 8601 format, when the endpoint is updated. EffectiveDate *string `type:"string"` - // Unused. + // Not used. EndpointStatus *string `type:"string"` - // The endpoint location attributes. + // The geographic information for the endpoint. Location *EndpointLocation `type:"structure"` - // Custom metrics that your app reports to Amazon Pinpoint. + // One or more custom metrics that your app reports to Amazon Pinpoint for the + // endpoint. Metrics map[string]*float64 `type:"map"` - // Indicates whether a user has opted out of receiving messages with one of - // the following values:ALL - User has opted out of all messages.NONE - Users - // has not opted out and receives all messages. + // Specifies whether the user who's associated with the endpoint has opted out + // of receiving messages and push notifications from you. Possible values are: + // ALL, the user has opted out and doesn't want to receive any messages or push + // notifications; and, NONE, the user hasn't opted out and wants to receive + // all messages and push notifications. OptOut *string `type:"string"` - // The unique ID for the most recent request to update the endpoint. + // The unique identifier for the most recent request to update the endpoint. RequestId *string `type:"string"` - // Custom user-specific attributes that your app reports to Amazon Pinpoint. + // One or more custom user attributes that describe the user who's associated + // with the endpoint. User *EndpointUser `type:"structure"` } @@ -12558,69 +13090,74 @@ func (s *EndpointRequest) SetUser(v *EndpointUser) *EndpointRequest { return s } -// Endpoint response +// Provides information about the channel type and other settings for an endpoint. type EndpointResponse struct { _ struct{} `type:"structure"` - // The address of the endpoint as provided by your push provider. For example, - // the DeviceToken or RegistrationId. + // The destination address for messages or push notifications that you send + // to the endpoint. The address varies by channel. For example, the address + // for a push-notification channel is typically the token provided by a push + // notification service, such as an Apple Push Notification service (APNs) device + // token or a Firebase Cloud Messaging (FCM) registration token. The address + // for the SMS channel is a phone number in E.164 format, such as +12065550100. + // The address for the email channel is an email address. Address *string `type:"string"` - // The ID of the application that is associated with the endpoint. + // The unique identifier for the application that's associated with the endpoint. ApplicationId *string `type:"string"` - // Custom attributes that describe the endpoint by associating a name with an - // array of values. For example, an attribute named "interests" might have the - // following values: ["science", "politics", "travel"]. You can use these attributes - // as selection criteria when you create segments.The Amazon Pinpoint console - // can't display attribute names that include the following characters: hash/pound - // sign (#), colon (:), question mark (?), backslash (\), and forward slash - // (/). For this reason, you should avoid using these characters in the names - // of custom attributes. + // One or more custom attributes that describe the endpoint by associating a + // name with an array of values. For example, the value of a custom attribute + // named Interests might be: ["science", "music", "travel"]. You can use these + // attributes as filter criteria when you create segments. Attributes map[string][]*string `type:"map"` - // The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX - // | ADM | SMS | EMAIL | BAIDU + // The channel that's used when sending messages or push notifications to the + // endpoint. ChannelType *string `type:"string" enum:"ChannelType"` - // A number from 0-99 that represents the cohort the endpoint is assigned to. - // Endpoints are grouped into cohorts randomly, and each cohort contains approximately - // 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to - // the holdout or treatment allocations for a campaign. + // A number from 0-99 that represents the cohort that the endpoint is assigned + // to. Endpoints are grouped into cohorts randomly, and each cohort contains + // approximately 1 percent of the endpoints for an application. Amazon Pinpoint + // assigns cohorts to the holdout or treatment allocations for campaigns. CohortId *string `type:"string"` - // The date and time when the endpoint was created, shown in ISO 8601 format. + // The date and time, in ISO 8601 format, when the endpoint was created. CreationDate *string `type:"string"` - // The endpoint demographic attributes. + // The demographic information for the endpoint, such as the time zone and platform. Demographic *EndpointDemographic `type:"structure"` - // The date and time when the endpoint was last updated, shown in ISO 8601 format. + // The date and time, in ISO 8601 format, when the endpoint was last updated. EffectiveDate *string `type:"string"` - // Unused. + // Not used. EndpointStatus *string `type:"string"` - // The unique ID that you assigned to the endpoint. The ID should be a globally - // unique identifier (GUID) to ensure that it doesn't conflict with other endpoint - // IDs associated with the application. + // The unique identifier that you assigned to the endpoint. The identifier should + // be a globally unique identifier (GUID) to ensure that it doesn't conflict + // with other endpoint identifiers that are associated with the application. Id *string `type:"string"` - // The endpoint location attributes. + // The geographic information for the endpoint. Location *EndpointLocation `type:"structure"` - // Custom metrics that your app reports to Amazon Pinpoint. + // One or more custom metrics that your app reports to Amazon Pinpoint for the + // endpoint. Metrics map[string]*float64 `type:"map"` - // Indicates whether a user has opted out of receiving messages with one of - // the following values:ALL - User has opted out of all messages.NONE - Users - // has not opted out and receives all messages. + // Specifies whether the user who's associated with the endpoint has opted out + // of receiving messages and push notifications from you. Possible values are: + // ALL, the user has opted out and doesn't want to receive any messages or push + // notifications; and, NONE, the user hasn't opted out and wants to receive + // all messages and push notifications. OptOut *string `type:"string"` - // The unique ID for the most recent request to update the endpoint. + // The unique identifier for the most recent request to update the endpoint. RequestId *string `type:"string"` - // Custom user-specific attributes that your app reports to Amazon Pinpoint. + // One or more custom user attributes that your app reports to Amazon Pinpoint + // for the user who's associated with the endpoint. User *EndpointUser `type:"structure"` } @@ -12724,28 +13261,32 @@ func (s *EndpointResponse) SetUser(v *EndpointUser) *EndpointResponse { return s } -// Endpoint send configuration. +// Specifies the content, including message variables and attributes, to use +// in a message that's sent directly to an endpoint. type EndpointSendConfiguration struct { _ struct{} `type:"structure"` - // Body override. If specified will override default body. + // The body of the message. If specified, this value overrides the default message + // body. BodyOverride *string `type:"string"` - // A map of custom attributes to attributes to be attached to the message for - // this address. This payload is added to the push notification's 'data.pinpoint' - // object or added to the email/sms delivery receipt event attributes. + // A map of custom attributes to attach to the message for the address. For + // a push notification, this payload is added to the data.pinpoint object. For + // an email or text message, this payload is added to email/SMS delivery receipt + // event attributes. Context map[string]*string `type:"map"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the message. If + // specified, this value overrides the message. RawContent *string `type:"string"` - // A map of substitution values for the message to be merged with the DefaultMessage's - // substitutions. Substitutions on this map take precedence over the all other - // substitutions. + // A map of the message variables to merge with the variables specified for + // the default message (DefaultMessage.Substitutions). The variables specified + // in this map take precedence over all other variables. Substitutions map[string][]*string `type:"map"` - // Title override. If specified will override default title if applicable. + // The title or subject line of the message. If specified, this value overrides + // the default message title or subject line. TitleOverride *string `type:"string"` } @@ -12789,21 +13330,24 @@ func (s *EndpointSendConfiguration) SetTitleOverride(v string) *EndpointSendConf return s } -// Endpoint user specific custom userAttributes +// Specifies data for one or more attributes that describe the user who's associated +// with an endpoint. type EndpointUser struct { _ struct{} `type:"structure"` - // Custom attributes that describe the user by associating a name with an array - // of values. For example, an attribute named "interests" might have the following - // values: ["science", "politics", "travel"]. You can use these attributes as - // selection criteria when you create segments.The Amazon Pinpoint console can't - // display attribute names that include the following characters: hash/pound - // sign (#), colon (:), question mark (?), backslash (\), and forward slash - // (/). For this reason, you should avoid using these characters in the names - // of custom attributes. + // One or more custom attributes that describe the user by associating a name + // with an array of values. For example, the value of an attribute named Interests + // might be: ["science", "music", "travel"]. You can use these attributes as + // filter criteria when you create segments. + // + // When you define the name of a custom attribute, avoid using the following + // characters: number sign (#), colon (:), question mark (?), backslash (\), + // and slash (/). The Amazon Pinpoint console can't display attribute names + // that contain these characters. This limitation doesn't apply to attribute + // values. UserAttributes map[string][]*string `type:"map"` - // The unique ID of the user. + // The unique identifier for the user. UserId *string `type:"string"` } @@ -12829,12 +13373,16 @@ func (s *EndpointUser) SetUserId(v string) *EndpointUser { return s } -// List of endpoints +// Provides information about all the endpoints that are associated with a user +// ID. type EndpointsResponse struct { _ struct{} `type:"structure"` - // The list of endpoints. - Item []*EndpointResponse `type:"list"` + // An array of responses, one for each endpoint that's associated with the user + // ID. + // + // Item is a required field + Item []*EndpointResponse `type:"list" required:"true"` } // String returns the string representation @@ -12853,11 +13401,11 @@ func (s *EndpointsResponse) SetItem(v []*EndpointResponse) *EndpointsResponse { return s } -// Model for creating or updating events. +// Specifies information about an event that reports data to Amazon Pinpoint. type Event struct { _ struct{} `type:"structure"` - // The package name associated with the app that's recording the event. + // The package name of the app that's recording the event. AppPackageName *string `type:"string"` // The title of the app that's recording the event. @@ -12866,16 +13414,18 @@ type Event struct { // The version number of the app that's recording the event. AppVersionCode *string `type:"string"` - // Custom attributes that are associated with the event you're adding or updating. + // One or more custom attributes that are associated with the event. Attributes map[string]*string `type:"map"` // The version of the SDK that's running on the client device. ClientSdkVersion *string `type:"string"` - // The name of the custom event that you're recording. - EventType *string `type:"string"` + // The name of the event. + // + // EventType is a required field + EventType *string `type:"string" required:"true"` - // Custom metrics related to the event. + // One or more custom metrics that are associated with the event. Metrics map[string]*float64 `type:"map"` // The name of the SDK that's being used to record the event. @@ -12884,8 +13434,10 @@ type Event struct { // Information about the session in which the event occurred. Session *Session `type:"structure"` - // The date and time when the event occurred, in ISO 8601 format. - Timestamp *string `type:"string"` + // The date and time, in ISO 8601 format, when the event occurred. + // + // Timestamp is a required field + Timestamp *string `type:"string" required:"true"` } // String returns the string representation @@ -12898,6 +13450,27 @@ func (s Event) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *Event) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Event"} + if s.EventType == nil { + invalidParams.Add(request.NewErrParamRequired("EventType")) + } + if s.Timestamp == nil { + invalidParams.Add(request.NewErrParamRequired("Timestamp")) + } + if s.Session != nil { + if err := s.Session.Validate(); err != nil { + invalidParams.AddNested("Session", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAppPackageName sets the AppPackageName field's value. func (s *Event) SetAppPackageName(v string) *Event { s.AppPackageName = &v @@ -12958,21 +13531,22 @@ func (s *Event) SetTimestamp(v string) *Event { return s } -// Event dimensions. +// Specifies the dimensions for an event filter that determines when a campaign +// is sent. type EventDimensions struct { _ struct{} `type:"structure"` - // Custom attributes that your app reports to Amazon Pinpoint. You can use these - // attributes as selection criteria when you create an event filter. + // One or more custom attributes that your app reports to Amazon Pinpoint. You + // can use these attributes as selection criteria when you create an event filter. Attributes map[string]*AttributeDimension `type:"map"` // The name of the event that causes the campaign to be sent. This can be a - // standard event type that Amazon Pinpoint generates, such as _session.start, + // standard type of event that Amazon Pinpoint generates, such as _session.start, // or a custom event that's specific to your app. EventType *SetDimension `type:"structure"` - // Custom metrics that your app reports to Amazon Pinpoint. You can use these - // attributes as selection criteria when you create an event filter. + // One or more custom metrics that your app reports to Amazon Pinpoint. You + // can use these metrics as selection criteria when you create an event filter. Metrics map[string]*MetricDimension `type:"map"` } @@ -12986,6 +13560,41 @@ func (s EventDimensions) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *EventDimensions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EventDimensions"} + if s.Attributes != nil { + for i, v := range s.Attributes { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Attributes", i), err.(request.ErrInvalidParams)) + } + } + } + if s.EventType != nil { + if err := s.EventType.Validate(); err != nil { + invalidParams.AddNested("EventType", err.(request.ErrInvalidParams)) + } + } + if s.Metrics != nil { + for i, v := range s.Metrics { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Metrics", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAttributes sets the Attributes field's value. func (s *EventDimensions) SetAttributes(v map[string]*AttributeDimension) *EventDimensions { s.Attributes = v @@ -13004,16 +13613,17 @@ func (s *EventDimensions) SetMetrics(v map[string]*MetricDimension) *EventDimens return s } -// A complex object that holds the status code and message as a result of processing -// an event. +// Provides the status code and message that result from processing an event. type EventItemResponse struct { _ struct{} `type:"structure"` - // A custom message that is associated with the processing of an event. + // A custom message that's returned in the response as a result of processing + // the event. Message *string `type:"string"` - // The status returned in the response as a result of processing the event.Possible - // values: 400 (for invalid events) and 202 (for events that were accepted). + // The status code that's returned in the response as a result of processing + // the event. Possible values are: 202, for events that were accepted; and, + // 400, for events that weren't valid. StatusCode *int64 `type:"integer"` } @@ -13039,33 +13649,44 @@ func (s *EventItemResponse) SetStatusCode(v int64) *EventItemResponse { return s } -// Model for an event publishing subscription export. +// Specifies settings for publishing event data to an Amazon Kinesis data stream +// or an Amazon Kinesis Data Firehose delivery stream. type EventStream struct { _ struct{} `type:"structure"` - // The ID of the application from which events should be published. - ApplicationId *string `type:"string"` - - // The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery - // stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME - // Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME - DestinationStreamArn *string `type:"string"` + // The unique identifier for the application to publish event data for. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // (Deprecated) Your AWS account ID, which you assigned to the ExternalID key - // in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This - // requirement is removed, and external IDs are not recommended for IAM roles - // assumed by Amazon Pinpoint. + // The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon + // Kinesis Data Firehose delivery stream to publish event data to. + // + // For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name + // + // For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name + // + // DestinationStreamArn is a required field + DestinationStreamArn *string `type:"string" required:"true"` + + // (Deprecated) Your AWS account ID, which you assigned to an external ID key + // in an IAM trust policy. Amazon Pinpoint previously used this value to assume + // an IAM role when publishing event data, but we removed this requirement. + // We don't recommend use of external IDs for IAM roles that are assumed by + // Amazon Pinpoint. ExternalId *string `type:"string"` - // The date the event stream was last updated in ISO 8601 format. + // The date, in ISO 8601 format, when the event stream was last modified. LastModifiedDate *string `type:"string"` // The IAM user who last modified the event stream. LastUpdatedBy *string `type:"string"` - // The IAM role that authorizes Amazon Pinpoint to publish events to the stream - // in your account. - RoleArn *string `type:"string"` + // The AWS Identity and Access Management (IAM) role that authorizes Amazon + // Pinpoint to publish event data to the stream in your AWS account. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` } // String returns the string representation @@ -13114,15 +13735,19 @@ func (s *EventStream) SetRoleArn(v string) *EventStream { return s } -// A batch of PublicEndpoints and Events to process. +// Specifies a batch of endpoints and events to process. type EventsBatch struct { _ struct{} `type:"structure"` - // The PublicEndpoint attached to the EndpointId from the request. - Endpoint *PublicEndpoint `type:"structure"` + // A set of properties and attributes that are associated with the endpoint. + // + // Endpoint is a required field + Endpoint *PublicEndpoint `type:"structure" required:"true"` - // An object that contains a set of events associated with the endpoint. - Events map[string]*Event `type:"map"` + // A set of properties that are associated with the event. + // + // Events is a required field + Events map[string]*Event `type:"map" required:"true"` } // String returns the string representation @@ -13135,6 +13760,32 @@ func (s EventsBatch) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *EventsBatch) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EventsBatch"} + if s.Endpoint == nil { + invalidParams.Add(request.NewErrParamRequired("Endpoint")) + } + if s.Events == nil { + invalidParams.Add(request.NewErrParamRequired("Events")) + } + if s.Events != nil { + for i, v := range s.Events { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Events", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetEndpoint sets the Endpoint field's value. func (s *EventsBatch) SetEndpoint(v *PublicEndpoint) *EventsBatch { s.Endpoint = v @@ -13147,13 +13798,15 @@ func (s *EventsBatch) SetEvents(v map[string]*Event) *EventsBatch { return s } -// A set of events to process. +// Specifies a batch of events to process. type EventsRequest struct { _ struct{} `type:"structure"` - // A batch of events to process. Each BatchItem consists of an endpoint ID as - // the key, and an EventsBatch object as the value. - BatchItem map[string]*EventsBatch `type:"map"` + // The batch of events to process. For each item in a batch, the endpoint ID + // acts as a key that has an EventsBatch object as its value. + // + // BatchItem is a required field + BatchItem map[string]*EventsBatch `type:"map" required:"true"` } // String returns the string representation @@ -13166,21 +13819,45 @@ func (s EventsRequest) GoString() string { return s.String() } -// SetBatchItem sets the BatchItem field's value. -func (s *EventsRequest) SetBatchItem(v map[string]*EventsBatch) *EventsRequest { - s.BatchItem = v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *EventsRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EventsRequest"} + if s.BatchItem == nil { + invalidParams.Add(request.NewErrParamRequired("BatchItem")) + } + if s.BatchItem != nil { + for i, v := range s.BatchItem { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "BatchItem", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// Custom messages associated with events. +// SetBatchItem sets the BatchItem field's value. +func (s *EventsRequest) SetBatchItem(v map[string]*EventsBatch) *EventsRequest { + s.BatchItem = v + return s +} + +// Provides information about endpoints and the events that they're associated +// with. type EventsResponse struct { _ struct{} `type:"structure"` - // A map that contains a multipart response for each endpoint. Each item in - // this object uses the endpoint ID as the key, and the item response as the - // value.If no item response exists, the value can also be one of the following: - // 202 (if the request was processed successfully) or 400 (if the payload was - // invalid, or required fields were missing). + // A map that contains a multipart response for each endpoint. For each item + // in this object, the endpoint ID is the key and the item response is the value. + // If no item response exists, the value can also be one of the following: 202, + // the request was processed successfully; or 400, the payload wasn't valid + // or required fields were missing. Results map[string]*ItemResponse `type:"map"` } @@ -13200,25 +13877,32 @@ func (s *EventsResponse) SetResults(v map[string]*ItemResponse) *EventsResponse return s } -// Export job request. +// Specifies the settings for a job that exports endpoint definitions to an +// Amazon Simple Storage Service (Amazon S3) bucket. type ExportJobRequest struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint - // access to the Amazon S3 location that endpoints will be exported to. - RoleArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location + // where you want to export endpoint definitions to. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` - // A URL that points to the location within an Amazon S3 bucket that will receive - // the export. The location is typically a folder with multiple files.The URL - // should follow this format: s3://bucket-name/folder-name/Amazon Pinpoint will - // export endpoints to this location. - S3UrlPrefix *string `type:"string"` + // The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket + // where you want to export endpoint definitions to. This location is typically + // a folder that contains multiple files. The URL should be in the following + // format: s3://bucket-name/folder-name/. + // + // S3UrlPrefix is a required field + S3UrlPrefix *string `type:"string" required:"true"` - // The ID of the segment to export endpoints from. If not present, Amazon Pinpoint - // exports all of the endpoints that belong to the application. + // The identifier for the segment to export endpoint definitions from. If you + // don't specify this value, Amazon Pinpoint exports definitions for all the + // endpoints that are associated with the application. SegmentId *string `type:"string"` - // The version of the segment to export if specified. + // The version of the segment to export endpoint definitions from, if specified. SegmentVersion *int64 `type:"integer"` } @@ -13232,6 +13916,22 @@ func (s ExportJobRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ExportJobRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ExportJobRequest"} + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.S3UrlPrefix == nil { + invalidParams.Add(request.NewErrParamRequired("S3UrlPrefix")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetRoleArn sets the RoleArn field's value. func (s *ExportJobRequest) SetRoleArn(v string) *ExportJobRequest { s.RoleArn = &v @@ -13256,25 +13956,34 @@ func (s *ExportJobRequest) SetSegmentVersion(v int64) *ExportJobRequest { return s } -// Export job resource. +// Provides information about the resource settings for a job that exports endpoint +// definitions to a file. The file can be added directly to an Amazon Simple +// Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded +// directly to a computer by using the Amazon Pinpoint console. type ExportJobResource struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint - // access to the Amazon S3 location that endpoints will be exported to. - RoleArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location + // where the endpoint definitions were exported to. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` - // A URL that points to the location within an Amazon S3 bucket that will receive - // the export. The location is typically a folder with multiple files.The URL - // should follow this format: s3://bucket-name/folder-name/Amazon Pinpoint will - // export endpoints to this location. - S3UrlPrefix *string `type:"string"` + // The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket + // where the endpoint definitions were exported to. This location is typically + // a folder that contains multiple files. The URL should be in the following + // format: s3://bucket-name/folder-name/. + // + // S3UrlPrefix is a required field + S3UrlPrefix *string `type:"string" required:"true"` - // The ID of the segment to export endpoints from. If not present, Amazon Pinpoint - // exports all of the endpoints that belong to the application. + // The identifier for the segment that the endpoint definitions were exported + // from. If this value isn't present, Amazon Pinpoint exported definitions for + // all the endpoints that are associated with the application. SegmentId *string `type:"string"` - // The version of the segment to export if specified. + // The version of the segment that the endpoint definitions were exported from. SegmentVersion *int64 `type:"integer"` } @@ -13312,53 +14021,73 @@ func (s *ExportJobResource) SetSegmentVersion(v int64) *ExportJobResource { return s } -// Export job response. +// Provides information about the status and settings of a job that exports +// endpoint definitions to a file. The file can be added directly to an Amazon +// Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API +// or downloaded directly to a computer by using the Amazon Pinpoint console. type ExportJobResponse struct { _ struct{} `type:"structure"` - // The unique ID of the application associated with the export job. - ApplicationId *string `type:"string"` + // The unique identifier for the application that's associated with the export + // job. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The number of pieces that have successfully completed as of the time of the - // request. + // The number of pieces that were processed successfully (completed) by the + // export job, as of the time of the request. CompletedPieces *int64 `type:"integer"` - // The date the job completed in ISO 8601 format. + // The date, in ISO 8601 format, when the export job was completed. CompletionDate *string `type:"string"` - // The date the job was created in ISO 8601 format. - CreationDate *string `type:"string"` + // The date, in ISO 8601 format, when the export job was created. + // + // CreationDate is a required field + CreationDate *string `type:"string" required:"true"` - // The export job settings. - Definition *ExportJobResource `type:"structure"` + // The resource settings that apply to the export job. + // + // Definition is a required field + Definition *ExportJobResource `type:"structure" required:"true"` - // The number of pieces that failed to be processed as of the time of the request. + // The number of pieces that weren't processed successfully (failed) by the + // export job, as of the time of the request. FailedPieces *int64 `type:"integer"` - // Provides up to 100 of the first failed entries for the job, if any exist. + // An array of entries, one for each of the first 100 entries that weren't processed + // successfully (failed) by the export job, if any. Failures []*string `type:"list"` - // The unique ID of the job. - Id *string `type:"string"` + // The unique identifier for the export job. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // The status of the job.Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, - // COMPLETED, FAILING, FAILEDThe job status is FAILED if one or more pieces - // failed. - JobStatus *string `type:"string" enum:"JobStatus"` + // The status of the export job. The job status is FAILED if Amazon Pinpoint + // wasn't able to process one or more pieces in the job. + // + // JobStatus is a required field + JobStatus *string `type:"string" required:"true" enum:"JobStatus"` - // The number of endpoints that were not processed; for example, because of - // syntax errors. + // The total number of endpoint definitions that weren't processed successfully + // (failed) by the export job, typically because an error, such as a syntax + // error, occurred. TotalFailures *int64 `type:"integer"` - // The total number of pieces that must be processed to finish the job. Each - // piece is an approximately equal portion of the endpoints. + // The total number of pieces that must be processed to complete the export + // job. Each piece consists of an approximately equal portion of the endpoint + // definitions that are part of the export job. TotalPieces *int64 `type:"integer"` - // The number of endpoints that were processed by the job. + // The total number of endpoint definitions that were processed by the export + // job. TotalProcessed *int64 `type:"integer"` - // The job type. Will be 'EXPORT'. - Type *string `type:"string"` + // The job type. This value is EXPORT for export jobs. + // + // Type is a required field + Type *string `type:"string" required:"true"` } // String returns the string representation @@ -13449,15 +14178,20 @@ func (s *ExportJobResponse) SetType(v string) *ExportJobResponse { return s } -// Export job list. +// Provides information about all the export jobs that are associated with an +// application or segment. An export job is a job that exports endpoint definitions +// to a file. type ExportJobsResponse struct { _ struct{} `type:"structure"` - // A list of export jobs for the application. - Item []*ExportJobResponse `type:"list"` + // An array of responses, one for each export job that's associated with the + // application (Export Jobs resource) or segment (Segment Export Jobs resource). + // + // Item is a required field + Item []*ExportJobResponse `type:"list" required:"true"` - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. + // The string to use in a subsequent request to get the next page of results + // in a paginated response. This value is null if there are no additional pages. NextToken *string `type:"string"` } @@ -13483,14 +14217,19 @@ func (s *ExportJobsResponse) SetNextToken(v string) *ExportJobsResponse { return s } -// Google Cloud Messaging credentials +// Specifies the status and settings of the GCM channel for an application. +// This channel enables Amazon Pinpoint to send push notifications through the +// Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. type GCMChannelRequest struct { _ struct{} `type:"structure"` - // Platform credential API key from Google. - ApiKey *string `type:"string"` + // The API key, also referred to as a server key, that you received from Google + // to communicate with Google services. + // + // ApiKey is a required field + ApiKey *string `type:"string" required:"true"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the GCM channel for the application. Enabled *bool `type:"boolean"` } @@ -13504,6 +14243,19 @@ func (s GCMChannelRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *GCMChannelRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GCMChannelRequest"} + if s.ApiKey == nil { + invalidParams.Add(request.NewErrParamRequired("ApiKey")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetApiKey sets the ApiKey field's value. func (s *GCMChannelRequest) SetApiKey(v string) *GCMChannelRequest { s.ApiKey = &v @@ -13516,41 +14268,51 @@ func (s *GCMChannelRequest) SetEnabled(v bool) *GCMChannelRequest { return s } -// Google Cloud Messaging channel definition +// Provides information about the status and settings of the GCM channel for +// an application. The GCM channel enables Amazon Pinpoint to send push notifications +// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging +// (GCM), service. type GCMChannelResponse struct { _ struct{} `type:"structure"` - // The ID of the application to which the channel applies. + // The unique identifier for the application that the GCM channel applies to. ApplicationId *string `type:"string"` - // When was this segment created + // The date and time when the GCM channel was enabled. CreationDate *string `type:"string"` - // The GCM API key from Google. - Credential *string `type:"string"` + // The API key, also referred to as a server key, that you received from Google + // to communicate with Google services. + // + // Credential is a required field + Credential *string `type:"string" required:"true"` - // If the channel is enabled for sending messages. + // Specifies whether the GCM channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Channel ID. Not used. Present only for backwards compatibility. + // (Deprecated) An identifier for the GCM channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the GCM channel is archived. IsArchived *bool `type:"boolean"` - // Who last updated this entry + // The user who last modified the GCM channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time when the GCM channel was last modified. LastModifiedDate *string `type:"string"` - // The platform type. Will be GCM - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the GCM + // channel, this value is GCM. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Version of channel + // The current version of the GCM channel. Version *int64 `type:"integer"` } @@ -13630,88 +14392,110 @@ func (s *GCMChannelResponse) SetVersion(v int64) *GCMChannelResponse { return s } -// GCM Message. +// Specifies the settings for a one-time message that's sent directly to an +// endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint +// to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud +// Messaging (GCM), service. type GCMMessage struct { _ struct{} `type:"structure"` - // The action that occurs if the user taps a push notification delivered by - // the campaign: OPEN_APP - Your app launches, or it becomes the foreground - // app if it has been sent to the background. This is the default action. DEEP_LINK - // - Uses deep linking features in iOS and Android to open your app and display - // a designated user interface within the app. URL - The default mobile browser - // on the user's device launches and opens a web page at the URL you specify. - // Possible values include: OPEN_APP | DEEP_LINK | URL + // The action to occur if the recipient taps the push notification. Valid values + // are: + // + // * OPEN_APP - Your app opens or it becomes the foreground app if it was + // sent to the background. This is the default action. + // + // * DEEP_LINK - Your app opens and displays a designated user interface + // in the app. This action uses the deep-linking features of the Android + // platform. + // + // * URL - The default mobile browser on the recipient's device opens and + // loads the web page at a URL that you specify. Action *string `type:"string" enum:"Action"` - // The message body of the notification. + // The body of the notification message. Body *string `type:"string"` - // This parameter identifies a group of messages (e.g., with collapse_key: "Updates - // Available") that can be collapsed, so that only the last message gets sent - // when delivery can be resumed. This is intended to avoid sending too many - // of the same messages when the device comes back online or becomes active. + // An arbitrary string that identifies a group of messages that can be collapsed + // to ensure that only the last message is sent when delivery can resume. This + // helps avoid sending too many instances of the same messages when the recipient's + // device comes online again or becomes active. + // + // Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) + // collapse_key parameter when it sends the notification message to FCM. CollapseKey *string `type:"string"` - // The data payload used for a silent push. This payload is added to the notifications' - // data.pinpoint.jsonBody' object + // The JSON data payload to use for the push notification, if the notification + // is a silent push notification. This payload is added to the data.pinpoint.jsonBody + // object of the notification. Data map[string]*string `type:"map"` - // The icon image name of the asset saved in your application. + // The icon image name of the asset saved in your app. IconReference *string `type:"string"` - // The URL that points to an image used as the large icon to the notification - // content view. + // The URL of the large icon image to display in the content view of the push + // notification. ImageIconUrl *string `type:"string"` - // The URL that points to an image used in the push notification. + // The URL of an image to display in the push notification. ImageUrl *string `type:"string"` - // The message priority. Amazon Pinpoint uses this value to set the FCM or GCM - // priority parameter when it sends the message. Accepts the following values:"Normal" - // - Messages might be delayed. Delivery is optimized for battery usage on the - // receiving device. Use normal priority unless immediate delivery is required."High" - // - Messages are sent immediately and might wake a sleeping device.The equivalent - // values for APNs messages are "5" and "10". Amazon Pinpoint accepts these - // values here and converts them.For more information, see About FCM Messages - // in the Firebase documentation. + // para>normal - The notification might be delayed. Delivery is optimized for + // battery usage on the recipient's device. Use this value unless immediate + // delivery is required. + // /listitem> + // high - The notification is sent immediately and might wake a sleeping device. + // /para> + // Amazon Pinpoint specifies this value in the FCM priority parameter when it + // sends the notification message to FCM. + // + // The equivalent values for Apple Push Notification service (APNs) are 5, for + // normal, and 10, for high. If you specify an APNs value for this property, + // Amazon Pinpoint accepts and converts the value to the corresponding FCM value. Priority *string `type:"string"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the notification + // message. This value overrides the message. RawContent *string `type:"string"` - // This parameter specifies the package name of the application where the registration - // tokens must match in order to receive the message. + // The package name of the application where registration tokens must match + // in order for the recipient to receive the message. RestrictedPackageName *string `type:"string"` - // Indicates if the message should display on the users device. Silent pushes - // can be used for Remote Configuration and Phone Home use cases. + // Specifies whether the notification is a silent push notification, which is + // a push notification that doesn't display on a recipient's device. Silent + // push notifications can be used for cases such as updating an app's configuration + // or supporting phone home functionality. SilentPush *bool `type:"boolean"` - // The URL that points to an image used as the small icon for the notification - // which will be used to represent the notification in the status bar and content - // view + // The URL of the small icon image to display in the status bar and the content + // view of the push notification. SmallImageIconUrl *string `type:"string"` - // Indicates a sound to play when the device receives the notification. Supports - // default, or the filename of a sound resource bundled in the app. Android - // sound files must reside in /res/raw/ + // The sound to play when the recipient receives the push notification. You + // can use the default stream or specify the file name of a sound resource that's + // bundled in your app. On an Android platform, the sound file must reside in + // /res/raw/. Sound *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the notification message. You can + // override the default variables with individual address variables. Substitutions map[string][]*string `type:"map"` - // The length of time (in seconds) that FCM or GCM stores and attempts to deliver - // the message. If unspecified, the value defaults to the maximum, which is - // 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM - // or GCM time_to_live parameter. + // The amount of time, in seconds, that FCM should store and attempt to deliver + // the push notification, if the service is unable to deliver the notification + // the first time. If you don't specify this value, FCM defaults to the maximum + // value, which is 2,419,200 seconds (28 days). + // + // Amazon Pinpoint specifies this value in the FCM time_to_live parameter when + // it sends the notification message to FCM. TimeToLive *int64 `type:"integer"` - // The message title that displays above the message on the user's device. + // The title to display above the notification message on the recipient's device. Title *string `type:"string"` - // The URL to open in the user's mobile browser. Used if the value for Action - // is URL. + // The URL to open in the recipient's default mobile browser, if a recipient + // taps the push notification and the value of the Action property is URL. Url *string `type:"string"` } @@ -13827,15 +14611,19 @@ func (s *GCMMessage) SetUrl(v string) *GCMMessage { return s } -// GPS coordinates +// Specifies the GPS coordinates of a location. type GPSCoordinates struct { _ struct{} `type:"structure"` - // Latitude - Latitude *float64 `type:"double"` + // The latitude coordinate of the location. + // + // Latitude is a required field + Latitude *float64 `type:"double" required:"true"` - // Longitude - Longitude *float64 `type:"double"` + // The longitude coordinate of the location. + // + // Longitude is a required field + Longitude *float64 `type:"double" required:"true"` } // String returns the string representation @@ -13848,6 +14636,22 @@ func (s GPSCoordinates) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *GPSCoordinates) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GPSCoordinates"} + if s.Latitude == nil { + invalidParams.Add(request.NewErrParamRequired("Latitude")) + } + if s.Longitude == nil { + invalidParams.Add(request.NewErrParamRequired("Longitude")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetLatitude sets the Latitude field's value. func (s *GPSCoordinates) SetLatitude(v float64) *GPSCoordinates { s.Latitude = &v @@ -13860,14 +14664,17 @@ func (s *GPSCoordinates) SetLongitude(v float64) *GPSCoordinates { return s } -// GPS point location dimension +// Specifies GPS-based criteria for including or excluding endpoints from a +// segment. type GPSPointDimension struct { _ struct{} `type:"structure"` - // Coordinate to measure distance from. - Coordinates *GPSCoordinates `type:"structure"` + // The GPS coordinates to measure distance from. + // + // Coordinates is a required field + Coordinates *GPSCoordinates `type:"structure" required:"true"` - // Range in kilometers from the coordinate. + // The range, in kilometers, from the GPS coordinates. RangeInKilometers *float64 `type:"double"` } @@ -13881,6 +14688,24 @@ func (s GPSPointDimension) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *GPSPointDimension) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GPSPointDimension"} + if s.Coordinates == nil { + invalidParams.Add(request.NewErrParamRequired("Coordinates")) + } + if s.Coordinates != nil { + if err := s.Coordinates.Validate(); err != nil { + invalidParams.AddNested("Coordinates", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetCoordinates sets the Coordinates field's value. func (s *GPSPointDimension) SetCoordinates(v *GPSCoordinates) *GPSPointDimension { s.Coordinates = v @@ -13935,7 +14760,8 @@ func (s *GetAdmChannelInput) SetApplicationId(v string) *GetAdmChannelInput { type GetAdmChannelOutput struct { _ struct{} `type:"structure" payload:"ADMChannelResponse"` - // Amazon Device Messaging channel definition. + // Provides information about the status and settings of the ADM (Amazon Device + // Messaging) channel for an application. // // ADMChannelResponse is a required field ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"` @@ -13999,7 +14825,8 @@ func (s *GetApnsChannelInput) SetApplicationId(v string) *GetApnsChannelInput { type GetApnsChannelOutput struct { _ struct{} `type:"structure" payload:"APNSChannelResponse"` - // Apple Distribution Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) channel for an application. // // APNSChannelResponse is a required field APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"` @@ -14063,7 +14890,8 @@ func (s *GetApnsSandboxChannelInput) SetApplicationId(v string) *GetApnsSandboxC type GetApnsSandboxChannelOutput struct { _ struct{} `type:"structure" payload:"APNSSandboxChannelResponse"` - // Apple Development Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) sandbox channel for an application. // // APNSSandboxChannelResponse is a required field APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"` @@ -14127,7 +14955,8 @@ func (s *GetApnsVoipChannelInput) SetApplicationId(v string) *GetApnsVoipChannel type GetApnsVoipChannelOutput struct { _ struct{} `type:"structure" payload:"APNSVoipChannelResponse"` - // Apple VoIP Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) VoIP channel for an application. // // APNSVoipChannelResponse is a required field APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"` @@ -14191,7 +15020,8 @@ func (s *GetApnsVoipSandboxChannelInput) SetApplicationId(v string) *GetApnsVoip type GetApnsVoipSandboxChannelOutput struct { _ struct{} `type:"structure" payload:"APNSVoipSandboxChannelResponse"` - // Apple VoIP Developer Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) VoIP sandbox channel for an application. // // APNSVoipSandboxChannelResponse is a required field APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"` @@ -14255,7 +15085,7 @@ func (s *GetAppInput) SetApplicationId(v string) *GetAppInput { type GetAppOutput struct { _ struct{} `type:"structure" payload:"ApplicationResponse"` - // Application Response. + // Provides information about an application. // // ApplicationResponse is a required field ApplicationResponse *ApplicationResponse `type:"structure" required:"true"` @@ -14319,7 +15149,8 @@ func (s *GetApplicationSettingsInput) SetApplicationId(v string) *GetApplication type GetApplicationSettingsOutput struct { _ struct{} `type:"structure" payload:"ApplicationSettingsResource"` - // Application settings. + // Provides information about an application, including the default settings + // for an application. // // ApplicationSettingsResource is a required field ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"` @@ -14374,7 +15205,7 @@ func (s *GetAppsInput) SetToken(v string) *GetAppsInput { type GetAppsOutput struct { _ struct{} `type:"structure" payload:"ApplicationsResponse"` - // Get Applications Result. + // Provides information about all of your applications. // // ApplicationsResponse is a required field ApplicationsResponse *ApplicationsResponse `type:"structure" required:"true"` @@ -14438,7 +15269,8 @@ func (s *GetBaiduChannelInput) SetApplicationId(v string) *GetBaiduChannelInput type GetBaiduChannelOutput struct { _ struct{} `type:"structure" payload:"BaiduChannelResponse"` - // Baidu Cloud Messaging channel definition + // Provides information about the status and settings of the Baidu (Baidu Cloud + // Push) channel for an application. // // BaiduChannelResponse is a required field BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"` @@ -14533,7 +15365,7 @@ func (s *GetCampaignActivitiesInput) SetToken(v string) *GetCampaignActivitiesIn type GetCampaignActivitiesOutput struct { _ struct{} `type:"structure" payload:"ActivitiesResponse"` - // Activities for campaign. + // Provides information about the activities that were performed by a campaign. // // ActivitiesResponse is a required field ActivitiesResponse *ActivitiesResponse `type:"structure" required:"true"` @@ -14612,7 +15444,8 @@ func (s *GetCampaignInput) SetCampaignId(v string) *GetCampaignInput { type GetCampaignOutput struct { _ struct{} `type:"structure" payload:"CampaignResponse"` - // Campaign definition + // Provides information about the status, configuration, and other settings + // for a campaign. // // CampaignResponse is a required field CampaignResponse *CampaignResponse `type:"structure" required:"true"` @@ -14706,7 +15539,8 @@ func (s *GetCampaignVersionInput) SetVersion(v string) *GetCampaignVersionInput type GetCampaignVersionOutput struct { _ struct{} `type:"structure" payload:"CampaignResponse"` - // Campaign definition + // Provides information about the status, configuration, and other settings + // for a campaign. // // CampaignResponse is a required field CampaignResponse *CampaignResponse `type:"structure" required:"true"` @@ -14801,7 +15635,8 @@ func (s *GetCampaignVersionsInput) SetToken(v string) *GetCampaignVersionsInput type GetCampaignVersionsOutput struct { _ struct{} `type:"structure" payload:"CampaignsResponse"` - // List of available campaigns. + // Provides information about the configuration and other settings for all the + // campaigns that are associated with an application. // // CampaignsResponse is a required field CampaignsResponse *CampaignsResponse `type:"structure" required:"true"` @@ -14881,7 +15716,8 @@ func (s *GetCampaignsInput) SetToken(v string) *GetCampaignsInput { type GetCampaignsOutput struct { _ struct{} `type:"structure" payload:"CampaignsResponse"` - // List of available campaigns. + // Provides information about the configuration and other settings for all the + // campaigns that are associated with an application. // // CampaignsResponse is a required field CampaignsResponse *CampaignsResponse `type:"structure" required:"true"` @@ -14945,7 +15781,8 @@ func (s *GetChannelsInput) SetApplicationId(v string) *GetChannelsInput { type GetChannelsOutput struct { _ struct{} `type:"structure" payload:"ChannelsResponse"` - // Get channels definition + // Provides information about the general settings and status of all channels + // for an application, including channels that aren't enabled for the application. // // ChannelsResponse is a required field ChannelsResponse *ChannelsResponse `type:"structure" required:"true"` @@ -15009,7 +15846,8 @@ func (s *GetEmailChannelInput) SetApplicationId(v string) *GetEmailChannelInput type GetEmailChannelOutput struct { _ struct{} `type:"structure" payload:"EmailChannelResponse"` - // Email Channel Response. + // Provides information about the status and settings of the email channel for + // an application. // // EmailChannelResponse is a required field EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"` @@ -15088,7 +15926,7 @@ func (s *GetEndpointInput) SetEndpointId(v string) *GetEndpointInput { type GetEndpointOutput struct { _ struct{} `type:"structure" payload:"EndpointResponse"` - // Endpoint response + // Provides information about the channel type and other settings for an endpoint. // // EndpointResponse is a required field EndpointResponse *EndpointResponse `type:"structure" required:"true"` @@ -15152,7 +15990,8 @@ func (s *GetEventStreamInput) SetApplicationId(v string) *GetEventStreamInput { type GetEventStreamOutput struct { _ struct{} `type:"structure" payload:"EventStream"` - // Model for an event publishing subscription export. + // Specifies settings for publishing event data to an Amazon Kinesis data stream + // or an Amazon Kinesis Data Firehose delivery stream. // // EventStream is a required field EventStream *EventStream `type:"structure" required:"true"` @@ -15231,7 +16070,10 @@ func (s *GetExportJobInput) SetJobId(v string) *GetExportJobInput { type GetExportJobOutput struct { _ struct{} `type:"structure" payload:"ExportJobResponse"` - // Export job response. + // Provides information about the status and settings of a job that exports + // endpoint definitions to a file. The file can be added directly to an Amazon + // Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API + // or downloaded directly to a computer by using the Amazon Pinpoint console. // // ExportJobResponse is a required field ExportJobResponse *ExportJobResponse `type:"structure" required:"true"` @@ -15311,7 +16153,9 @@ func (s *GetExportJobsInput) SetToken(v string) *GetExportJobsInput { type GetExportJobsOutput struct { _ struct{} `type:"structure" payload:"ExportJobsResponse"` - // Export job list. + // Provides information about all the export jobs that are associated with an + // application or segment. An export job is a job that exports endpoint definitions + // to a file. // // ExportJobsResponse is a required field ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"` @@ -15375,7 +16219,10 @@ func (s *GetGcmChannelInput) SetApplicationId(v string) *GetGcmChannelInput { type GetGcmChannelOutput struct { _ struct{} `type:"structure" payload:"GCMChannelResponse"` - // Google Cloud Messaging channel definition + // Provides information about the status and settings of the GCM channel for + // an application. The GCM channel enables Amazon Pinpoint to send push notifications + // through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging + // (GCM), service. // // GCMChannelResponse is a required field GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"` @@ -15454,7 +16301,10 @@ func (s *GetImportJobInput) SetJobId(v string) *GetImportJobInput { type GetImportJobOutput struct { _ struct{} `type:"structure" payload:"ImportJobResponse"` - // Import job response. + // Provides information about the status and settings of a job that imports + // endpoint definitions from one or more files. The files can be stored in an + // Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from + // a computer by using the Amazon Pinpoint console. // // ImportJobResponse is a required field ImportJobResponse *ImportJobResponse `type:"structure" required:"true"` @@ -15534,7 +16384,9 @@ func (s *GetImportJobsInput) SetToken(v string) *GetImportJobsInput { type GetImportJobsOutput struct { _ struct{} `type:"structure" payload:"ImportJobsResponse"` - // Import job list. + // Provides information about the status and settings of all the import jobs + // that are associated with an application or segment. An import job is a job + // that imports endpoint definitions from one or more files. // // ImportJobsResponse is a required field ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"` @@ -15629,7 +16481,9 @@ func (s *GetSegmentExportJobsInput) SetToken(v string) *GetSegmentExportJobsInpu type GetSegmentExportJobsOutput struct { _ struct{} `type:"structure" payload:"ExportJobsResponse"` - // Export job list. + // Provides information about all the export jobs that are associated with an + // application or segment. An export job is a job that exports endpoint definitions + // to a file. // // ExportJobsResponse is a required field ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"` @@ -15724,7 +16578,9 @@ func (s *GetSegmentImportJobsInput) SetToken(v string) *GetSegmentImportJobsInpu type GetSegmentImportJobsOutput struct { _ struct{} `type:"structure" payload:"ImportJobsResponse"` - // Import job list. + // Provides information about the status and settings of all the import jobs + // that are associated with an application or segment. An import job is a job + // that imports endpoint definitions from one or more files. // // ImportJobsResponse is a required field ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"` @@ -15803,7 +16659,8 @@ func (s *GetSegmentInput) SetSegmentId(v string) *GetSegmentInput { type GetSegmentOutput struct { _ struct{} `type:"structure" payload:"SegmentResponse"` - // Segment definition. + // Provides information about the configuration, dimension, and other settings + // for a segment. // // SegmentResponse is a required field SegmentResponse *SegmentResponse `type:"structure" required:"true"` @@ -15897,7 +16754,8 @@ func (s *GetSegmentVersionInput) SetVersion(v string) *GetSegmentVersionInput { type GetSegmentVersionOutput struct { _ struct{} `type:"structure" payload:"SegmentResponse"` - // Segment definition. + // Provides information about the configuration, dimension, and other settings + // for a segment. // // SegmentResponse is a required field SegmentResponse *SegmentResponse `type:"structure" required:"true"` @@ -15992,7 +16850,7 @@ func (s *GetSegmentVersionsInput) SetToken(v string) *GetSegmentVersionsInput { type GetSegmentVersionsOutput struct { _ struct{} `type:"structure" payload:"SegmentsResponse"` - // Segments in your account. + // Provides information about all the segments that are associated with an application. // // SegmentsResponse is a required field SegmentsResponse *SegmentsResponse `type:"structure" required:"true"` @@ -16072,7 +16930,7 @@ func (s *GetSegmentsInput) SetToken(v string) *GetSegmentsInput { type GetSegmentsOutput struct { _ struct{} `type:"structure" payload:"SegmentsResponse"` - // Segments in your account. + // Provides information about all the segments that are associated with an application. // // SegmentsResponse is a required field SegmentsResponse *SegmentsResponse `type:"structure" required:"true"` @@ -16136,7 +16994,8 @@ func (s *GetSmsChannelInput) SetApplicationId(v string) *GetSmsChannelInput { type GetSmsChannelOutput struct { _ struct{} `type:"structure" payload:"SMSChannelResponse"` - // SMS Channel Response. + // Provides information about the status and settings of the SMS channel for + // an application. // // SMSChannelResponse is a required field SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"` @@ -16215,7 +17074,8 @@ func (s *GetUserEndpointsInput) SetUserId(v string) *GetUserEndpointsInput { type GetUserEndpointsOutput struct { _ struct{} `type:"structure" payload:"EndpointsResponse"` - // List of endpoints + // Provides information about all the endpoints that are associated with a user + // ID. // // EndpointsResponse is a required field EndpointsResponse *EndpointsResponse `type:"structure" required:"true"` @@ -16279,7 +17139,8 @@ func (s *GetVoiceChannelInput) SetApplicationId(v string) *GetVoiceChannelInput type GetVoiceChannelOutput struct { _ struct{} `type:"structure" payload:"VoiceChannelResponse"` - // Voice Channel Response. + // Provides information about the status and settings of the voice channel for + // an application. // // VoiceChannelResponse is a required field VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"` @@ -16301,43 +17162,61 @@ func (s *GetVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) return s } -// Import job request. +// Specifies the settings for a job that imports endpoint definitions from an +// Amazon Simple Storage Service (Amazon S3) bucket. type ImportJobRequest struct { _ struct{} `type:"structure"` - // Sets whether the endpoints create a segment when they are imported. + // Specifies whether to create a segment that contains the endpoints, when the + // endpoint definitions are imported. DefineSegment *bool `type:"boolean"` - // (Deprecated) Your AWS account ID, which you assigned to the ExternalID key - // in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This - // requirement is removed, and external IDs are not recommended for IAM roles - // assumed by Amazon Pinpoint. + // (Deprecated) Your AWS account ID, which you assigned to an external ID key + // in an IAM trust policy. Amazon Pinpoint previously used this value to assume + // an IAM role when importing endpoint definitions, but we removed this requirement. + // We don't recommend use of external IDs for IAM roles that are assumed by + // Amazon Pinpoint. ExternalId *string `type:"string"` - // The format of the files that contain the endpoint definitions.Valid values: - // CSV, JSON - Format *string `type:"string" enum:"Format"` + // The format of the files that contain the endpoint definitions to import. + // Valid values are: CSV, for comma-separated values format; and, JSON, for + // newline-delimited JSON format. If the Amazon S3 location stores multiple + // files that use different formats, Amazon Pinpoint imports data only from + // the files that use the specified format. + // + // Format is a required field + Format *string `type:"string" required:"true" enum:"Format"` - // Sets whether the endpoints are registered with Amazon Pinpoint when they - // are imported. + // Specifies whether to register the endpoints with Amazon Pinpoint, when the + // endpoint definitions are imported. RegisterEndpoints *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint - // access to the Amazon S3 location that contains the endpoints to import. - RoleArn *string `type:"string"` - - // The URL of the S3 bucket that contains the segment information to import. - // The location can be a folder or a single file. The URL should use the following - // format: s3://bucket-name/folder-name/file-nameAmazon Pinpoint imports endpoints - // from this location and any subfolders it contains. - S3Url *string `type:"string"` + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location + // to import endpoint definitions from. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` + + // The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains + // the endpoint definitions to import. This location can be a folder or a single + // file. If the location is a folder, Amazon Pinpoint imports endpoint definitions + // from the files in this location, including any subfolders that the folder + // contains. + // + // The URL should be in the following format: s3://bucket-name/folder-name/file-name. + // The location can end with the key for an individual object or a prefix that + // qualifies multiple objects. + // + // S3Url is a required field + S3Url *string `type:"string" required:"true"` - // The ID of the segment to update if the import job is meant to update an existing - // segment. + // The identifier for the segment to update or add the imported endpoint definitions + // to, if the import job is meant to update an existing segment. SegmentId *string `type:"string"` - // A custom name for the segment created by the import job. Use if DefineSegment - // is true. + // The custom name for the segment that's created by the import job, if the + // value of the DefineSegment property is true. SegmentName *string `type:"string"` } @@ -16351,6 +17230,25 @@ func (s ImportJobRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ImportJobRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ImportJobRequest"} + if s.Format == nil { + invalidParams.Add(request.NewErrParamRequired("Format")) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.S3Url == nil { + invalidParams.Add(request.NewErrParamRequired("S3Url")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDefineSegment sets the DefineSegment field's value. func (s *ImportJobRequest) SetDefineSegment(v bool) *ImportJobRequest { s.DefineSegment = &v @@ -16399,43 +17297,65 @@ func (s *ImportJobRequest) SetSegmentName(v string) *ImportJobRequest { return s } -// Import job resource +// Provides information about the resource settings for a job that imports endpoint +// definitions from one or more files. The files can be stored in an Amazon +// Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer +// by using the Amazon Pinpoint console. type ImportJobResource struct { _ struct{} `type:"structure"` - // Sets whether the endpoints create a segment when they are imported. + // Specifies whether the import job creates a segment that contains the endpoints, + // when the endpoint definitions are imported. DefineSegment *bool `type:"boolean"` - // (Deprecated) Your AWS account ID, which you assigned to the ExternalID key - // in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This - // requirement is removed, and external IDs are not recommended for IAM roles - // assumed by Amazon Pinpoint. + // (Deprecated) Your AWS account ID, which you assigned to an external ID key + // in an IAM trust policy. Amazon Pinpoint previously used this value to assume + // an IAM role when importing endpoint definitions, but we removed this requirement. + // We don't recommend use of external IDs for IAM roles that are assumed by + // Amazon Pinpoint. ExternalId *string `type:"string"` - // The format of the files that contain the endpoint definitions.Valid values: - // CSV, JSON - Format *string `type:"string" enum:"Format"` + // The format of the files that contain the endpoint definitions to import. + // Valid values are: CSV, for comma-separated values format; and, JSON, for + // newline-delimited JSON format. + // + // If the files are stored in an Amazon S3 location and that location contains + // multiple files that use different formats, Amazon Pinpoint imports data only + // from the files that use the specified format. + // + // Format is a required field + Format *string `type:"string" required:"true" enum:"Format"` - // Sets whether the endpoints are registered with Amazon Pinpoint when they - // are imported. + // Specifies whether the import job registers the endpoints with Amazon Pinpoint, + // when the endpoint definitions are imported. RegisterEndpoints *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint - // access to the Amazon S3 location that contains the endpoints to import. - RoleArn *string `type:"string"` - - // The URL of the S3 bucket that contains the segment information to import. - // The location can be a folder or a single file. The URL should use the following - // format: s3://bucket-name/folder-name/file-nameAmazon Pinpoint imports endpoints - // from this location and any subfolders it contains. - S3Url *string `type:"string"` + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location + // to import endpoint definitions from. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` + + // The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains + // the endpoint definitions to import. This location can be a folder or a single + // file. If the location is a folder, Amazon Pinpoint imports endpoint definitions + // from the files in this location, including any subfolders that the folder + // contains. + // + // The URL should be in the following format: s3://bucket-name/folder-name/file-name. + // The location can end with the key for an individual object or a prefix that + // qualifies multiple objects. + // + // S3Url is a required field + S3Url *string `type:"string" required:"true"` - // The ID of the segment to update if the import job is meant to update an existing - // segment. + // The identifier for the segment that the import job updates or adds endpoint + // definitions to, if the import job updates an existing segment. SegmentId *string `type:"string"` - // A custom name for the segment created by the import job. Use if DefineSegment - // is true. + // The custom name for the segment that's created by the import job, if the + // value of the DefineSegment property is true. SegmentName *string `type:"string"` } @@ -16497,53 +17417,73 @@ func (s *ImportJobResource) SetSegmentName(v string) *ImportJobResource { return s } -// Import job response. +// Provides information about the status and settings of a job that imports +// endpoint definitions from one or more files. The files can be stored in an +// Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from +// a computer by using the Amazon Pinpoint console. type ImportJobResponse struct { _ struct{} `type:"structure"` - // The unique ID of the application to which the import job applies. - ApplicationId *string `type:"string"` + // The unique identifier for the application that's associated with the import + // job. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The number of pieces that have successfully imported as of the time of the - // request. + // The number of pieces that were processed successfully (completed) by the + // import job, as of the time of the request. CompletedPieces *int64 `type:"integer"` - // The date the import job completed in ISO 8601 format. + // The date, in ISO 8601 format, when the import job was completed. CompletionDate *string `type:"string"` - // The date the import job was created in ISO 8601 format. - CreationDate *string `type:"string"` + // The date, in ISO 8601 format, when the import job was created. + // + // CreationDate is a required field + CreationDate *string `type:"string" required:"true"` - // The import job settings. - Definition *ImportJobResource `type:"structure"` + // The resource settings that apply to the import job. + // + // Definition is a required field + Definition *ImportJobResource `type:"structure" required:"true"` - // The number of pieces that have failed to import as of the time of the request. + // The number of pieces that weren't processed successfully (failed) by the + // import job, as of the time of the request. FailedPieces *int64 `type:"integer"` - // Provides up to 100 of the first failed entries for the job, if any exist. + // An array of entries, one for each of the first 100 entries that weren't processed + // successfully (failed) by the import job, if any. Failures []*string `type:"list"` - // The unique ID of the import job. - Id *string `type:"string"` + // The unique identifier for the import job. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // The status of the import job.Valid values: CREATED, INITIALIZING, PROCESSING, - // COMPLETING, COMPLETED, FAILING, FAILEDThe job status is FAILED if one or - // more pieces failed to import. - JobStatus *string `type:"string" enum:"JobStatus"` + // The status of the import job. The job status is FAILED if Amazon Pinpoint + // wasn't able to process one or more pieces in the job. + // + // JobStatus is a required field + JobStatus *string `type:"string" required:"true" enum:"JobStatus"` - // The number of endpoints that failed to import; for example, because of syntax - // errors. + // The total number of endpoint definitions that weren't processed successfully + // (failed) by the import job, typically because an error, such as a syntax + // error, occurred. TotalFailures *int64 `type:"integer"` - // The total number of pieces that must be imported to finish the job. Each - // piece is an approximately equal portion of the endpoints to import. + // The total number of pieces that must be processed to complete the import + // job. Each piece consists of an approximately equal portion of the endpoint + // definitions that are part of the import job. TotalPieces *int64 `type:"integer"` - // The number of endpoints that were processed by the import job. + // The total number of endpoint definitions that were processed by the import + // job. TotalProcessed *int64 `type:"integer"` - // The job type. Will be Import. - Type *string `type:"string"` + // The job type. This value is IMPORT for import jobs. + // + // Type is a required field + Type *string `type:"string" required:"true"` } // String returns the string representation @@ -16634,15 +17574,20 @@ func (s *ImportJobResponse) SetType(v string) *ImportJobResponse { return s } -// Import job list. +// Provides information about the status and settings of all the import jobs +// that are associated with an application or segment. An import job is a job +// that imports endpoint definitions from one or more files. type ImportJobsResponse struct { _ struct{} `type:"structure"` - // A list of import jobs for the application. - Item []*ImportJobResponse `type:"list"` + // An array of responses, one for each import job that's associated with the + // application (Import Jobs resource) or segment (Segment Import Jobs resource). + // + // Item is a required field + Item []*ImportJobResponse `type:"list" required:"true"` - // The string that you use in a subsequent request to get the next page of results - // in a paginated response. + // The string to use in a subsequent request to get the next page of results + // in a paginated response. This value is null if there are no additional pages. NextToken *string `type:"string"` } @@ -16668,15 +17613,16 @@ func (s *ImportJobsResponse) SetNextToken(v string) *ImportJobsResponse { return s } -// The response that's provided after registering the endpoint. +// Provides information about the results of a request to create or update an +// endpoint that's associated with an event. type ItemResponse struct { _ struct{} `type:"structure"` - // The response received after the endpoint was accepted. + // The response that was received after the endpoint data was accepted. EndpointItemResponse *EndpointItemResponse `type:"structure"` - // A multipart response object that contains a key and value for each event - // ID in the request. In each object, the event ID is the key, and an EventItemResponse + // A multipart response object that contains a key and a value for each event + // in the request. In each object, the event ID is the key and an EventItemResponse // object is the value. EventsItemResponse map[string]*EventItemResponse `type:"map"` } @@ -16745,6 +17691,8 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure" payload:"TagsModel"` + // Specifies the tags (keys and values) for an application, campaign, or segment. + // // TagsModel is a required field TagsModel *TagsModel `type:"structure" required:"true"` } @@ -16765,60 +17713,72 @@ func (s *ListTagsForResourceOutput) SetTagsModel(v *TagsModel) *ListTagsForResou return s } -// Message to send +// Specifies the content and settings for a push notification that's sent to +// recipients of a campaign. type Message struct { _ struct{} `type:"structure"` - // The action that occurs if the user taps a push notification delivered by - // the campaign:OPEN_APP - Your app launches, or it becomes the foreground app - // if it has been sent to the background. This is the default action.DEEP_LINK - // - Uses deep linking features in iOS and Android to open your app and display - // a designated user interface within the app.URL - The default mobile browser - // on the user's device launches and opens a web page at the URL you specify. + // The action to occur if a recipient taps the push notification. Valid values + // are: + // + // * OPEN_APP - Your app opens or it becomes the foreground app if it was + // sent to the background. This is the default action. + // + // * DEEP_LINK - Your app opens and displays a designated user interface + // in the app. This setting uses the deep-linking features of iOS and Android. + // + // * URL - The default mobile browser on the recipient's device opens and + // loads the web page at a URL that you specify. Action *string `type:"string" enum:"Action"` - // The message body. Can include up to 140 characters. + // The body of the notification message. The maximum number of characters is + // 200. Body *string `type:"string"` - // The URL that points to the icon image for the push notification icon, for - // example, the app icon. + // The URL of the image to display as the push-notification icon, such as the + // icon for the app. ImageIconUrl *string `type:"string"` - // The URL that points to the small icon image for the push notification icon, - // for example, the app icon. + // The URL of the image to display as the small, push-notification icon, such + // as a small version of the icon for the app. ImageSmallIconUrl *string `type:"string"` - // The URL that points to an image used in the push notification. + // The URL of an image to display in the push notification. ImageUrl *string `type:"string"` - // The JSON payload used for a silent push. + // The JSON payload to use for a silent push notification. JsonBody *string `type:"string"` - // A URL that refers to the location of an image or video that you want to display - // in the push notification. + // The URL of the image or video to display in the push notification. MediaUrl *string `type:"string"` - // The Raw JSON formatted string to be used as the payload. This value overrides - // the message. + // The raw, JSON-formatted string to use as the payload for the notification + // message. This value overrides other values for the message. RawContent *string `type:"string"` - // Indicates if the message should display on the users device.Silent pushes - // can be used for Remote Configuration and Phone Home use cases. + // Specifies whether the notification is a silent push notification, which is + // a push notification that doesn't display on a recipient's device. Silent + // push notifications can be used for cases such as updating an app's configuration, + // displaying messages in an in-app message center, or supporting phone home + // functionality. SilentPush *bool `type:"boolean"` - // This parameter specifies how long (in seconds) the message should be kept - // if the service is unable to deliver the notification the first time. If the - // value is 0, it treats the notification as if it expires immediately and does - // not store the notification or attempt to redeliver it. This value is converted - // to the expiration field when sent to the service. It only applies to APNs - // and GCM + // The number of seconds that the push-notification service should keep the + // message, if the service is unable to deliver the notification the first time. + // This value is converted to an expiration value when it's sent to a push-notification + // service. If this value is 0, the service treats the notification as if it + // expires immediately and the service doesn't store or try to deliver the notification + // again. + // + // This value doesn't apply to messages that are sent through the Amazon Device + // Messaging (ADM) service. TimeToLive *int64 `type:"integer"` - // The message title that displays above the message on the user's device. + // The title to display above the notification message on a recipient's device. Title *string `type:"string"` - // The URL to open in the user's mobile browser. Used if the value for Action - // is URL. + // The URL to open in a recipient's default mobile browser, if a recipient taps + // the push notification and the value of the Action property is URL. Url *string `type:"string"` } @@ -16904,14 +17864,14 @@ func (s *Message) SetUrl(v string) *Message { return s } -// Simple message object. +// Provides information about an API request or response. type MessageBody struct { _ struct{} `type:"structure"` - // The error message that's returned from the API. + // The message that's returned from the API. Message *string `type:"string"` - // The unique message body ID. + // The unique identifier for the request or response. RequestID *string `type:"string"` } @@ -16937,33 +17897,36 @@ func (s *MessageBody) SetRequestID(v string) *MessageBody { return s } -// Message configuration for a campaign. +// Specifies the message configuration settings for a campaign. type MessageConfiguration struct { _ struct{} `type:"structure"` - // The message that the campaign delivers to ADM channels. Overrides the default - // message. + // The message that the campaign sends through the ADM (Amazon Device Messaging) + // channel. This message overrides the default message. ADMMessage *Message `type:"structure"` - // The message that the campaign delivers to APNS channels. Overrides the default - // message. + // The message that the campaign sends through the APNs (Apple Push Notification + // service) channel. This message overrides the default message. APNSMessage *Message `type:"structure"` - // The message that the campaign delivers to Baidu channels. Overrides the default - // message. + // The message that the campaign sends through the Baidu (Baidu Cloud Push) + // channel. This message overrides the default message. BaiduMessage *Message `type:"structure"` - // The default message for all channels. + // The default message that the campaign sends through all the channels that + // are configured for the campaign. DefaultMessage *Message `type:"structure"` - // The email message configuration. + // The message that the campaign sends through the email channel. EmailMessage *CampaignEmailMessage `type:"structure"` - // The message that the campaign delivers to GCM channels. Overrides the default - // message. + // The message that the campaign sends through the GCM channel, which enables + // Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging + // (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides + // the default message. GCMMessage *Message `type:"structure"` - // The SMS message configuration. + // The message that the campaign sends through the SMS channel. SMSMessage *CampaignSmsMessage `type:"structure"` } @@ -16977,6 +17940,21 @@ func (s MessageConfiguration) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *MessageConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MessageConfiguration"} + if s.EmailMessage != nil { + if err := s.EmailMessage.Validate(); err != nil { + invalidParams.AddNested("EmailMessage", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetADMMessage sets the ADMMessage field's value. func (s *MessageConfiguration) SetADMMessage(v *Message) *MessageConfiguration { s.ADMMessage = v @@ -17019,30 +17997,36 @@ func (s *MessageConfiguration) SetSMSMessage(v *CampaignSmsMessage) *MessageConf return s } -// Send message request. +// Specifies the objects that define configuration and other settings for a +// message. type MessageRequest struct { _ struct{} `type:"structure"` // A map of key-value pairs, where each key is an address and each value is // an AddressConfiguration object. An address can be a push notification token, - // a phone number, or an email address. + // a phone number, or an email address. You can use an AddressConfiguration + // object to tailor the message for an address by specifying settings such as + // content overrides and message variables. Addresses map[string]*AddressConfiguration `type:"map"` - // A map of custom attributes to attributes to be attached to the message. This - // payload is added to the push notification's 'data.pinpoint' object or added - // to the email/sms delivery receipt event attributes. + // A map of custom attributes to attach to the message. For a push notification, + // this payload is added to the data.pinpoint object. For an email or text message, + // this payload is added to email/SMS delivery receipt event attributes. Context map[string]*string `type:"map"` // A map of key-value pairs, where each key is an endpoint ID and each value - // is an EndpointSendConfiguration object. Within an EndpointSendConfiguration - // object, you can tailor the message for an endpoint by specifying message - // overrides or substitutions. + // is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration + // object to tailor the message for an endpoint by specifying settings such + // as content overrides and message variables. Endpoints map[string]*EndpointSendConfiguration `type:"map"` - // Message configuration. - MessageConfiguration *DirectMessageConfiguration `type:"structure"` + // The set of properties that defines the configuration settings for the message. + // + // MessageConfiguration is a required field + MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"` - // A unique ID that you can use to trace a message. This ID is visible to recipients. + // The unique identifier for tracing the message. This identifier is visible + // to message recipients. TraceId *string `type:"string"` } @@ -17056,6 +18040,19 @@ func (s MessageRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *MessageRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MessageRequest"} + if s.MessageConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("MessageConfiguration")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAddresses sets the Addresses field's value. func (s *MessageRequest) SetAddresses(v map[string]*AddressConfiguration) *MessageRequest { s.Addresses = v @@ -17086,23 +18083,27 @@ func (s *MessageRequest) SetTraceId(v string) *MessageRequest { return s } -// Send message response. +// Provides information about the results of a request to send a message to +// an endpoint address. type MessageResponse struct { _ struct{} `type:"structure"` - // Application id of the message. - ApplicationId *string `type:"string"` + // The unique identifier for the application that was used to send the message. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // A map containing a multi part response for each address, with the endpointId - // as the key and the result as the value. + // A map that contains a multipart response for each address that the message + // was sent to. In the map, the endpoint ID is the key and the result is the + // value. EndpointResult map[string]*EndpointMessageResult `type:"map"` - // Original request Id for which this message was delivered. + // The identifier for the original request that the message was delivered for. RequestId *string `type:"string"` - // A map containing a multi part response for each address, with the address - // as the key(Email address, phone number or push token) and the result as the - // value. + // A map that contains a multipart response for each address (email address, + // phone number, or push notification token) that the message was sent to. In + // the map, the address is the key and the result is the value. Result map[string]*MessageResult `type:"map"` } @@ -17140,36 +18141,53 @@ func (s *MessageResponse) SetResult(v map[string]*MessageResult) *MessageRespons return s } -// The result from sending a message to an address. +// Provides information about the results of sending a message directly to an +// endpoint address. type MessageResult struct { _ struct{} `type:"structure"` - // The delivery status of the message. Possible values:SUCCESS - The message - // was successfully delivered to the endpoint.TRANSIENT_FAILURE - A temporary - // error occurred. Amazon Pinpoint will attempt to deliver the message again - // later.FAILURE_PERMANENT - An error occurred when delivering the message to - // the endpoint. Amazon Pinpoint won't attempt to send the message again.TIMEOUT - // - The message couldn't be sent within the timeout period.QUIET_TIME - The - // local time for the endpoint was within the QuietTime for the campaign or - // app.DAILY_CAP - The endpoint has received the maximum number of messages - // it can receive within a 24-hour period.HOLDOUT - The endpoint was in a hold - // out treatment for the campaign.THROTTLED - Amazon Pinpoint throttled sending - // to this endpoint.EXPIRED - The endpoint address is expired.CAMPAIGN_CAP - - // The endpoint received the maximum number of messages allowed by the campaign.SERVICE_FAILURE - // - A service-level failure prevented Amazon Pinpoint from delivering the message.UNKNOWN - // - An unknown error occurred. - DeliveryStatus *string `type:"string" enum:"DeliveryStatus"` - - // Unique message identifier associated with the message that was sent. + // The delivery status of the message. Possible values are: + // + // * DUPLICATE - The endpoint address is a duplicate of another endpoint + // address. Amazon Pinpoint won't attempt to send the message again. + // + // * OPT_OUT - The user who's associated with the endpoint address has opted + // out of receiving messages from you. Amazon Pinpoint won't attempt to send + // the message again. + // + // * PERMANENT_FAILURE - An error occurred when delivering the message to + // the endpoint address. Amazon Pinpoint won't attempt to send the message + // again. + // + // * SUCCESSFUL - The message was successfully delivered to the endpoint + // address. + // + // * TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will + // attempt to deliver the message again later. + // + // * THROTTLED - Amazon Pinpoint throttled the operation to send the message + // to the endpoint address. + // + // * TIMEOUT - The message couldn't be sent within the timeout period. + // + // * UNKNOWN_FAILURE - An unknown error occurred. + // + // DeliveryStatus is a required field + DeliveryStatus *string `type:"string" required:"true" enum:"DeliveryStatus"` + + // The unique identifier for the message that was sent. MessageId *string `type:"string"` - // Downstream service status code. - StatusCode *int64 `type:"integer"` + // The downstream service status code for delivering the message. + // + // StatusCode is a required field + StatusCode *int64 `type:"integer" required:"true"` - // Status message for message delivery. + // The status message for delivering the message. StatusMessage *string `type:"string"` - // If token was updated as part of delivery. (This is GCM Specific) + // For push notifications that are sent through the GCM channel, specifies whether + // the token was updated as part of delivering the message. UpdatedToken *string `type:"string"` } @@ -17213,16 +18231,22 @@ func (s *MessageResult) SetUpdatedToken(v string) *MessageResult { return s } -// Custom metric dimension +// Specifies metric-based criteria for including or excluding endpoints from +// a segment. These criteria derive from custom metrics that you define for +// endpoints. type MetricDimension struct { _ struct{} `type:"structure"` - // The operator that you're using to compare metric values. Possible values: - // GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL - ComparisonOperator *string `type:"string"` + // The operator to use when comparing metric values. Valid values are: GREATER_THAN, + // LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL. + // + // ComparisonOperator is a required field + ComparisonOperator *string `type:"string" required:"true"` - // The value to be compared. - Value *float64 `type:"double"` + // The value to compare. + // + // Value is a required field + Value *float64 `type:"double" required:"true"` } // String returns the string representation @@ -17235,6 +18259,22 @@ func (s MetricDimension) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *MetricDimension) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MetricDimension"} + if s.ComparisonOperator == nil { + invalidParams.Add(request.NewErrParamRequired("ComparisonOperator")) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetComparisonOperator sets the ComparisonOperator field's value. func (s *MetricDimension) SetComparisonOperator(v string) *MetricDimension { s.ComparisonOperator = &v @@ -17247,17 +18287,17 @@ func (s *MetricDimension) SetValue(v float64) *MetricDimension { return s } -// Phone Number Validate request. +// Specifies a phone number to validate and retrieve information about. type NumberValidateRequest struct { _ struct{} `type:"structure"` - // (Optional) The two-character ISO country code for the country or region where - // the phone number was originally registered. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region where the phone number was originally registered. IsoCountryCode *string `type:"string"` - // The phone number to get information about. The phone number that you provide - // should include a country code. If the number doesn't include a valid country - // code, the operation might result in an error. + // The phone number to retrieve information about. The phone number that you + // provide should include a valid numeric country code. Otherwise, the operation + // might result in an error. PhoneNumber *string `type:"string"` } @@ -17283,56 +18323,59 @@ func (s *NumberValidateRequest) SetPhoneNumber(v string) *NumberValidateRequest return s } -// Phone Number Validate response. +// Provides information about a phone number. type NumberValidateResponse struct { _ struct{} `type:"structure"` - // The carrier or servive provider that the phone number is currently registered + // The carrier or service provider that the phone number is currently registered // with. Carrier *string `type:"string"` - // The city where the phone number was originally registered. + // The name of the city where the phone number was originally registered. City *string `type:"string"` - // The cleansed phone number, shown in E.164 format. + // The cleansed phone number, in E.164 format, for the location where the phone + // number was originally registered. CleansedPhoneNumberE164 *string `type:"string"` - // The cleansed phone number, shown in the local phone number format. + // The cleansed phone number, in the format for the location where the phone + // number was originally registered. CleansedPhoneNumberNational *string `type:"string"` - // The country or region where the phone number was originally registered. + // The name of the country or region where the phone number was originally registered. Country *string `type:"string"` - // The two-character ISO code for the country or region where the phone number - // was originally registered. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region where the phone number was originally registered. CountryCodeIso2 *string `type:"string"` // The numeric code for the country or region where the phone number was originally // registered. CountryCodeNumeric *string `type:"string"` - // The county where the phone number was originally registered. + // The name of the county where the phone number was originally registered. County *string `type:"string"` - // The two-character code (in ISO 3166-1 alpha-2 format) for the country or - // region in the request body. + // The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the + // request body. OriginalCountryCodeIso2 *string `type:"string"` - // The phone number that you included in the request body. + // The phone number that was sent in the request body. OriginalPhoneNumber *string `type:"string"` - // A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, + // The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, // INVALID, PREPAID, and OTHER. PhoneType *string `type:"string"` - // The phone type, represented by an integer. Possible values include 0 (MOBILE), - // 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID). + // The phone type, represented by an integer. Valid values are: 0 (mobile), + // 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid). PhoneTypeCode *int64 `type:"integer"` // The time zone for the location where the phone number was originally registered. Timezone *string `type:"string"` - // The postal code for the location where the phone number was originally registered. + // The postal or ZIP code for the location where the phone number was originally + // registered. ZipCode *string `type:"string"` } @@ -17433,7 +18476,7 @@ func (s *NumberValidateResponse) SetZipCode(v string) *NumberValidateResponse { type PhoneNumberValidateInput struct { _ struct{} `type:"structure" payload:"NumberValidateRequest"` - // Phone Number Validate request. + // Specifies a phone number to validate and retrieve information about. // // NumberValidateRequest is a required field NumberValidateRequest *NumberValidateRequest `type:"structure" required:"true"` @@ -17471,7 +18514,7 @@ func (s *PhoneNumberValidateInput) SetNumberValidateRequest(v *NumberValidateReq type PhoneNumberValidateOutput struct { _ struct{} `type:"structure" payload:"NumberValidateResponse"` - // Phone Number Validate response. + // Provides information about a phone number. // // NumberValidateResponse is a required field NumberValidateResponse *NumberValidateResponse `type:"structure" required:"true"` @@ -17493,46 +18536,53 @@ func (s *PhoneNumberValidateOutput) SetNumberValidateResponse(v *NumberValidateR return s } -// Public endpoint attributes. +// Specifies the properties and attributes of an endpoint that's associated +// with an event. type PublicEndpoint struct { _ struct{} `type:"structure"` - // The unique identifier for the recipient. For example, an address could be - // a device token, email address, or mobile phone number. + // The unique identifier for the recipient, such as a device token, email address, + // or mobile phone number. Address *string `type:"string"` - // Custom attributes that your app reports to Amazon Pinpoint. You can use these - // attributes as selection criteria when you create a segment. + // One or more custom attributes that describe the endpoint by associating a + // name with an array of values. You can use these attributes as filter criteria + // when you create segments. Attributes map[string][]*string `type:"map"` - // The channel type.Valid values: APNS, GCM + // The channel that's used when sending messages or push notifications to the + // endpoint. ChannelType *string `type:"string" enum:"ChannelType"` - // The endpoint demographic attributes. + // The demographic information for the endpoint, such as the time zone and platform. Demographic *EndpointDemographic `type:"structure"` - // The date and time when the endpoint was last updated, in ISO 8601 format. + // The date and time, in ISO 8601 format, when the endpoint was last updated. EffectiveDate *string `type:"string"` - // The status of the endpoint. If the update fails, the value is INACTIVE. If - // the endpoint is updated successfully, the value is ACTIVE. + // The status of the update request for the endpoint. Possible values are: INACTIVE, + // the update failed; and, ACTIVE, the endpoint was updated successfully. EndpointStatus *string `type:"string"` - // The endpoint location attributes. + // The geographic information for the endpoint. Location *EndpointLocation `type:"structure"` - // Custom metrics that your app reports to Amazon Pinpoint. + // One or more custom metrics that your app reports to Amazon Pinpoint for the + // endpoint. Metrics map[string]*float64 `type:"map"` - // Indicates whether a user has opted out of receiving messages with one of - // the following values:ALL - User has opted out of all messages.NONE - Users - // has not opted out and receives all messages. + // Specifies whether the user who's associated with the endpoint has opted out + // of receiving messages and push notifications from you. Possible values are: + // ALL, the user has opted out and doesn't want to receive any messages or push + // notifications; and, NONE, the user hasn't opted out and wants to receive + // all messages and push notifications. OptOut *string `type:"string"` - // A unique identifier that is generated each time the endpoint is updated. + // A unique identifier that's generated each time the endpoint is updated. RequestId *string `type:"string"` - // Custom user-specific attributes that your app reports to Amazon Pinpoint. + // One or more custom user attributes that your app reports to Amazon Pinpoint + // for the user who's associated with the endpoint. User *EndpointUser `type:"structure"` } @@ -17618,7 +18668,9 @@ type PutEventStreamInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Request to save an EventStream. + // Specifies the Amazon Resource Name (ARN) of an event stream to publish events + // to and the AWS Identity and Access Management (IAM) role to use when publishing + // those events. // // WriteEventStream is a required field WriteEventStream *WriteEventStream `type:"structure" required:"true"` @@ -17646,6 +18698,11 @@ func (s *PutEventStreamInput) Validate() error { if s.WriteEventStream == nil { invalidParams.Add(request.NewErrParamRequired("WriteEventStream")) } + if s.WriteEventStream != nil { + if err := s.WriteEventStream.Validate(); err != nil { + invalidParams.AddNested("WriteEventStream", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -17668,7 +18725,8 @@ func (s *PutEventStreamInput) SetWriteEventStream(v *WriteEventStream) *PutEvent type PutEventStreamOutput struct { _ struct{} `type:"structure" payload:"EventStream"` - // Model for an event publishing subscription export. + // Specifies settings for publishing event data to an Amazon Kinesis data stream + // or an Amazon Kinesis Data Firehose delivery stream. // // EventStream is a required field EventStream *EventStream `type:"structure" required:"true"` @@ -17696,7 +18754,7 @@ type PutEventsInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // A set of events to process. + // Specifies a batch of events to process. // // EventsRequest is a required field EventsRequest *EventsRequest `type:"structure" required:"true"` @@ -17724,6 +18782,11 @@ func (s *PutEventsInput) Validate() error { if s.EventsRequest == nil { invalidParams.Add(request.NewErrParamRequired("EventsRequest")) } + if s.EventsRequest != nil { + if err := s.EventsRequest.Validate(); err != nil { + invalidParams.AddNested("EventsRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -17746,7 +18809,8 @@ func (s *PutEventsInput) SetEventsRequest(v *EventsRequest) *PutEventsInput { type PutEventsOutput struct { _ struct{} `type:"structure" payload:"EventsResponse"` - // Custom messages associated with events. + // Provides information about endpoints and the events that they're associated + // with. // // EventsResponse is a required field EventsResponse *EventsResponse `type:"structure" required:"true"` @@ -17768,20 +18832,21 @@ func (s *PutEventsOutput) SetEventsResponse(v *EventsResponse) *PutEventsOutput return s } -// Quiet Time +// Specifies the start and end times that define a time range when messages +// aren't sent to endpoints. type QuietTime struct { _ struct{} `type:"structure"` - // The time at which quiet time should end. The value that you specify has to - // be in HH:mm format, where HH is the hour in 24-hour format (with a leading - // zero, if applicable), and mm is the minutes. For example, use 02:30 to represent - // 2:30 AM, or 14:30 to represent 2:30 PM. + // The specific time when quiet time ends. This value has to use 24-hour notation + // and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) + // and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 + // to represent 2:30 PM. End *string `type:"string"` - // The time at which quiet time should begin. The value that you specify has - // to be in HH:mm format, where HH is the hour in 24-hour format (with a leading - // zero, if applicable), and mm is the minutes. For example, use 02:30 to represent - // 2:30 AM, or 14:30 to represent 2:30 PM. + // The specific time when quiet time begins. This value has to use 24-hour notation + // and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) + // and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 + // to represent 2:30 PM. Start *string `type:"string"` } @@ -17807,11 +18872,12 @@ func (s *QuietTime) SetStart(v string) *QuietTime { return s } -// An email represented as a raw MIME message. +// Specifies the contents of an email message, represented as a raw MIME message. type RawEmail struct { _ struct{} `type:"structure"` - // The raw email message itself. Then entire message must be base64-encoded. + // The email message, represented as a raw MIME message. The entire message + // must be base64 encoded. // // Data is automatically base64 encoded/decoded by the SDK. Data []byte `type:"blob"` @@ -17833,18 +18899,23 @@ func (s *RawEmail) SetData(v []byte) *RawEmail { return s } -// Define how a segment based on recency of use. +// Specifies criteria for including or excluding endpoints from a segment based +// on how recently an endpoint was active. type RecencyDimension struct { _ struct{} `type:"structure"` - // The length of time during which users have been active or inactive with your - // app.Valid values: HR_24, DAY_7, DAY_14, DAY_30 - Duration *string `type:"string" enum:"Duration"` + // The duration to use when determining whether an endpoint is active or inactive. + // + // Duration is a required field + Duration *string `type:"string" required:"true" enum:"Duration"` - // The recency dimension type:ACTIVE - Users who have used your app within the - // specified duration are included in the segment.INACTIVE - Users who have - // not used your app within the specified duration are included in the segment. - RecencyType *string `type:"string" enum:"RecencyType"` + // The type of recency dimension to use for the segment. Valid values are: ACTIVE, + // endpoints that were active within the specified duration are included in + // the segment; and, INACTIVE, endpoints that weren't active within the specified + // duration are included in the segment. + // + // RecencyType is a required field + RecencyType *string `type:"string" required:"true" enum:"RecencyType"` } // String returns the string representation @@ -17857,6 +18928,22 @@ func (s RecencyDimension) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *RecencyDimension) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RecencyDimension"} + if s.Duration == nil { + invalidParams.Add(request.NewErrParamRequired("Duration")) + } + if s.RecencyType == nil { + invalidParams.Add(request.NewErrParamRequired("RecencyType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDuration sets the Duration field's value. func (s *RecencyDimension) SetDuration(v string) *RecencyDimension { s.Duration = &v @@ -17878,7 +18965,8 @@ type RemoveAttributesInput struct { // AttributeType is a required field AttributeType *string `location:"uri" locationName:"attribute-type" type:"string" required:"true"` - // Update attributes request + // Specifies one or more attributes to remove from all the endpoints that are + // associated with an application. // // UpdateAttributesRequest is a required field UpdateAttributesRequest *UpdateAttributesRequest `type:"structure" required:"true"` @@ -17940,7 +19028,8 @@ func (s *RemoveAttributesInput) SetUpdateAttributesRequest(v *UpdateAttributesRe type RemoveAttributesOutput struct { _ struct{} `type:"structure" payload:"AttributesResource"` - // Attributes. + // Provides information about the type and the names of attributes that were + // removed from all the endpoints that are associated with an application. // // AttributesResource is a required field AttributesResource *AttributesResource `type:"structure" required:"true"` @@ -17962,17 +19051,19 @@ func (s *RemoveAttributesOutput) SetAttributesResource(v *AttributesResource) *R return s } -// SMS Channel Request +// Specifies the status and settings of the SMS channel for an application. type SMSChannelRequest struct { _ struct{} `type:"structure"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the SMS channel for the application. Enabled *bool `type:"boolean"` - // Sender identifier of your messages. + // The identity that you want to display on recipients' devices when they receive + // messages from the SMS channel. SenderId *string `type:"string"` - // ShortCode registered with phone provider. + // The registered short code that you want to use when you send messages through + // the SMS channel. ShortCode *string `type:"string"` } @@ -18004,50 +19095,58 @@ func (s *SMSChannelRequest) SetShortCode(v string) *SMSChannelRequest { return s } -// SMS Channel Response. +// Provides information about the status and settings of the SMS channel for +// an application. type SMSChannelResponse struct { _ struct{} `type:"structure"` - // The unique ID of the application to which the SMS channel belongs. + // The unique identifier for the application that the SMS channel applies to. ApplicationId *string `type:"string"` - // The date that the settings were last updated in ISO 8601 format. + // The date and time, in ISO 8601 format, when the SMS channel was enabled. CreationDate *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the SMS channel is enabled for the application. Enabled *bool `type:"boolean"` - // Not used. Retained for backwards compatibility. + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the SMS channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the SMS channel is archived. IsArchived *bool `type:"boolean"` - // Who last updated this entry + // The user who last modified the SMS channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time, in ISO 8601 format, when the SMS channel was last modified. LastModifiedDate *string `type:"string"` - // Platform type. Will be "SMS" - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the SMS + // channel, this value is SMS. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Promotional messages per second that can be sent + // The maximum number of promotional messages that you can send through the + // SMS channel each second. PromotionalMessagesPerSecond *int64 `type:"integer"` - // Sender identifier of your messages. + // The identity that displays on recipients' devices when they receive messages + // from the SMS channel. SenderId *string `type:"string"` - // The short code registered with the phone provider. + // The registered short code to use when you send messages through the SMS channel. ShortCode *string `type:"string"` - // Transactional messages per second that can be sent + // The maximum number of transactional messages that you can send through the + // SMS channel each second. TransactionalMessagesPerSecond *int64 `type:"integer"` - // Version of channel + // The current version of the SMS channel. Version *int64 `type:"integer"` } @@ -18145,7 +19244,8 @@ func (s *SMSChannelResponse) SetVersion(v int64) *SMSChannelResponse { return s } -// SMS Message. +// Specifies the default settings for a one-time SMS message that's sent directly +// to an endpoint. type SMSMessage struct { _ struct{} `type:"structure"` @@ -18156,20 +19256,24 @@ type SMSMessage struct { // your dedicated number. Keyword *string `type:"string"` - // Is this a transaction priority message or lower priority. + // The SMS message type. Valid values are: TRANSACTIONAL, the message is critical + // or time-sensitive, such as a one-time password that supports a customer transaction; + // and, PROMOTIONAL, the message is not critical or time-sensitive, such as + // a marketing message. MessageType *string `type:"string" enum:"MessageType"` - // The phone number that the SMS message originates from. Specify one of the + // The number that the SMS message originates from. This should be one of the // dedicated long codes or short codes that you requested from AWS Support and - // that is assigned to your account. If this attribute is not specified, Amazon - // Pinpoint randomly assigns a long code. + // is assigned to your AWS account. If you don't specify a long or short code, + // Amazon Pinpoint assigns a random long code to the SMS message. OriginationNumber *string `type:"string"` - // The sender ID that is shown as the message sender on the recipient's device. + // The sender ID to display as the sender of the message on a recipient's device. // Support for sender IDs varies by country or region. SenderId *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The message variables to use in the SMS message. You can override the default + // variables with individual address variables. Substitutions map[string][]*string `type:"map"` } @@ -18219,43 +19323,53 @@ func (s *SMSMessage) SetSubstitutions(v map[string][]*string) *SMSMessage { return s } -// Shcedule that defines when a campaign is run. +// Specifies the schedule settings for a campaign. type Schedule struct { _ struct{} `type:"structure"` - // The scheduled time that the campaign ends in ISO 8601 format. + // The scheduled time, in ISO 8601 format, for the campaign to end. EndTime *string `type:"string"` - // Defines the type of events that can trigger the campaign. Used when the Frequency - // is set to EVENT. + // The type of event that causes the campaign to be sent, if the value of the + // Frequency property is EVENT. EventFilter *CampaignEventFilter `type:"structure"` - // How often the campaign delivers messages.Valid values:ONCEHOURLYDAILYWEEKLYMONTHLYEVENT + // Specifies how often the campaign is sent or whether the campaign is sent + // in response to a specific event. Frequency *string `type:"string" enum:"Frequency"` - // Indicates whether the campaign schedule takes effect according to each user's - // local time. + // Specifies whether the start and end times for the campaign schedule use each + // recipient's local time. To base the schedule on each recipient's local time, + // set this value to true. IsLocalTime *bool `type:"boolean"` - // The default quiet time for the campaign. The campaign doesn't send messages - // to endpoints during the quiet time.Note: Make sure that your endpoints include - // the Demographics.Timezone attribute if you plan to enable a quiet time for - // your campaign. If your endpoints don't include this attribute, they'll receive - // the messages that you send them, even if quiet time is enabled.When you set - // up a campaign to use quiet time, the campaign doesn't send messages during - // the time range you specified, as long as all of the following are true:- - // The endpoint includes a valid Demographic.Timezone attribute.- The current - // time in the endpoint's time zone is later than or equal to the time specified - // in the QuietTime.Start attribute for the campaign.- The current time in the - // endpoint's time zone is earlier than or equal to the time specified in the - // QuietTime.End attribute for the campaign. + // The default quiet time for the campaign. Quiet time is a specific time range + // when a campaign doesn't send messages to endpoints, if all the following + // conditions are met: + // + // * The EndpointDemographic.Timezone property of the endpoint is set to + // a valid value. + // + // * The current time in the endpoint's time zone is later than or equal + // to the time specified by the QuietTime.Start property for the campaign. + // + // * The current time in the endpoint's time zone is earlier than or equal + // to the time specified by the QuietTime.End property for the campaign. + // + // If any of the preceding conditions isn't met, the endpoint will receive messages + // from the campaign, even if quiet time is enabled. QuietTime *QuietTime `type:"structure"` - // The scheduled time that the campaign begins in ISO 8601 format. - StartTime *string `type:"string"` - - // The starting UTC offset for the schedule if the value for isLocalTime is - // trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11 + // The scheduled time, in ISO 8601 format, for the campaign to begin. + // + // StartTime is a required field + StartTime *string `type:"string" required:"true"` + + // The starting UTC offset for the campaign schedule, if the value of the IsLocalTime + // property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, + // UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, + // UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, + // UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. Timezone *string `type:"string"` } @@ -18269,6 +19383,24 @@ func (s Schedule) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *Schedule) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Schedule"} + if s.StartTime == nil { + invalidParams.Add(request.NewErrParamRequired("StartTime")) + } + if s.EventFilter != nil { + if err := s.EventFilter.Validate(); err != nil { + invalidParams.AddNested("EventFilter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetEndTime sets the EndTime field's value. func (s *Schedule) SetEndTime(v string) *Schedule { s.EndTime = &v @@ -18311,11 +19443,12 @@ func (s *Schedule) SetTimezone(v string) *Schedule { return s } -// Segment behavior dimensions +// Specifies dimension settings for including or excluding endpoints from a +// segment based on how recently an endpoint was active. type SegmentBehaviors struct { _ struct{} `type:"structure"` - // The recency of use. + // The dimension settings that are based on how recently an endpoint was active. Recency *RecencyDimension `type:"structure"` } @@ -18329,13 +19462,30 @@ func (s SegmentBehaviors) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentBehaviors) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentBehaviors"} + if s.Recency != nil { + if err := s.Recency.Validate(); err != nil { + invalidParams.AddNested("Recency", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetRecency sets the Recency field's value. func (s *SegmentBehaviors) SetRecency(v *RecencyDimension) *SegmentBehaviors { s.Recency = v return s } -// Segment demographic dimensions +// Specifies demographic-based dimension settings for including or excluding +// endpoints from a segment. These settings derive from characteristics of endpoint +// devices, such as platform, make, and model. type SegmentDemographics struct { _ struct{} `type:"structure"` @@ -18368,6 +19518,46 @@ func (s SegmentDemographics) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentDemographics) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentDemographics"} + if s.AppVersion != nil { + if err := s.AppVersion.Validate(); err != nil { + invalidParams.AddNested("AppVersion", err.(request.ErrInvalidParams)) + } + } + if s.Channel != nil { + if err := s.Channel.Validate(); err != nil { + invalidParams.AddNested("Channel", err.(request.ErrInvalidParams)) + } + } + if s.DeviceType != nil { + if err := s.DeviceType.Validate(); err != nil { + invalidParams.AddNested("DeviceType", err.(request.ErrInvalidParams)) + } + } + if s.Make != nil { + if err := s.Make.Validate(); err != nil { + invalidParams.AddNested("Make", err.(request.ErrInvalidParams)) + } + } + if s.Model != nil { + if err := s.Model.Validate(); err != nil { + invalidParams.AddNested("Model", err.(request.ErrInvalidParams)) + } + } + if s.Platform != nil { + if err := s.Platform.Validate(); err != nil { + invalidParams.AddNested("Platform", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAppVersion sets the AppVersion field's value. func (s *SegmentDemographics) SetAppVersion(v *SetDimension) *SegmentDemographics { s.AppVersion = v @@ -18404,26 +19594,27 @@ func (s *SegmentDemographics) SetPlatform(v *SetDimension) *SegmentDemographics return s } -// Segment dimensions +// Specifies the dimension settings for a segment. type SegmentDimensions struct { _ struct{} `type:"structure"` - // Custom segment attributes. + // One or more custom attributes to use as criteria for the segment. Attributes map[string]*AttributeDimension `type:"map"` - // The segment behaviors attributes. + // The behavior-based criteria, such as how recently users have used your app, + // for the segment. Behavior *SegmentBehaviors `type:"structure"` - // The segment demographics attributes. + // The demographic-based criteria, such as device platform, for the segment. Demographic *SegmentDemographics `type:"structure"` - // The segment location attributes. + // The location-based criteria, such as region or GPS coordinates, for the segment. Location *SegmentLocation `type:"structure"` - // Custom segment metrics. + // One or more custom metrics to use as criteria for the segment. Metrics map[string]*MetricDimension `type:"map"` - // Custom segment user attributes. + // One or more custom user attributes to use as criteria for the segment. UserAttributes map[string]*AttributeDimension `type:"map"` } @@ -18437,6 +19628,61 @@ func (s SegmentDimensions) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentDimensions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentDimensions"} + if s.Attributes != nil { + for i, v := range s.Attributes { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Attributes", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Behavior != nil { + if err := s.Behavior.Validate(); err != nil { + invalidParams.AddNested("Behavior", err.(request.ErrInvalidParams)) + } + } + if s.Demographic != nil { + if err := s.Demographic.Validate(); err != nil { + invalidParams.AddNested("Demographic", err.(request.ErrInvalidParams)) + } + } + if s.Location != nil { + if err := s.Location.Validate(); err != nil { + invalidParams.AddNested("Location", err.(request.ErrInvalidParams)) + } + } + if s.Metrics != nil { + for i, v := range s.Metrics { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Metrics", i), err.(request.ErrInvalidParams)) + } + } + } + if s.UserAttributes != nil { + for i, v := range s.UserAttributes { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "UserAttributes", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAttributes sets the Attributes field's value. func (s *SegmentDimensions) SetAttributes(v map[string]*AttributeDimension) *SegmentDimensions { s.Attributes = v @@ -18473,31 +19719,33 @@ func (s *SegmentDimensions) SetUserAttributes(v map[string]*AttributeDimension) return s } -// Segment group definition. +// Specifies the base segments and dimensions for a segment, and the relationships +// between these base segments and dimensions. type SegmentGroup struct { _ struct{} `type:"structure"` - // List of dimensions to include or exclude. + // An array that defines the dimensions for the segment. Dimensions []*SegmentDimensions `type:"list"` - // The base segment that you build your segment on. The source segment defines - // the starting "universe" of endpoints. When you add dimensions to the segment, - // it filters the source segment based on the dimensions that you specify. You - // can specify more than one dimensional segment. You can only specify one imported - // segment.NOTE: If you specify an imported segment for this attribute, the - // segment size estimate that appears in the Amazon Pinpoint console shows the - // size of the imported segment, without any filters applied to it. + // The base segment to build the segment on. A base segment, also referred to + // as a source segment, defines the initial population of endpoints for a segment. + // When you add dimensions to a segment, Amazon Pinpoint filters the base segment + // by using the dimensions that you specify. + // + // You can specify more than one dimensional segment or only one imported segment. + // If you specify an imported segment, the Amazon Pinpoint console displays + // a segment size estimate that indicates the size of the imported segment without + // any filters applied to it. SourceSegments []*SegmentReference `type:"list"` - // Specify how to handle multiple source segments. For example, if you specify - // three source segments, should the resulting segment be based on any or all - // of the segments? Acceptable values: ANY or ALL. + // Specifies how to handle multiple base segments for the segment. For example, + // if you specify three base segments for the segment, whether the resulting + // segment is based on all, any, or none of the base segments. SourceType *string `type:"string" enum:"SourceType"` - // Specify how to handle multiple segment dimensions. For example, if you specify - // three dimensions, should the resulting segment include endpoints that are - // matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, - // or NONE. + // Specifies how to handle multiple dimensions for the segment. For example, + // if you specify three dimensions for the segment, whether the resulting segment + // includes endpoints that match all, any, or none of the dimensions. Type *string `type:"string" enum:"Type"` } @@ -18511,6 +19759,36 @@ func (s SegmentGroup) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentGroup) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentGroup"} + if s.Dimensions != nil { + for i, v := range s.Dimensions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Dimensions", i), err.(request.ErrInvalidParams)) + } + } + } + if s.SourceSegments != nil { + for i, v := range s.SourceSegments { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SourceSegments", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDimensions sets the Dimensions field's value. func (s *SegmentGroup) SetDimensions(v []*SegmentDimensions) *SegmentGroup { s.Dimensions = v @@ -18535,17 +19813,18 @@ func (s *SegmentGroup) SetType(v string) *SegmentGroup { return s } -// Segment group definition. +// Specifies the settings that define the relationships between segment groups +// for a segment. type SegmentGroupList struct { _ struct{} `type:"structure"` - // A set of segment criteria to evaluate. + // An array that defines the set of segment criteria to evaluate when handling + // segment groups for the segment. Groups []*SegmentGroup `type:"list"` - // Specify how to handle multiple segment groups. For example, if the segment - // includes three segment groups, should the resulting segment include endpoints - // that are matched by all, any, or none of the segment groups you created. - // Acceptable values: ALL, ANY, or NONE. + // Specifies how to handle multiple segment groups for the segment. For example, + // if the segment includes three segment groups, whether the resulting segment + // includes endpoints that match all, any, or none of the segment groups. Include *string `type:"string" enum:"Include"` } @@ -18559,6 +19838,26 @@ func (s SegmentGroupList) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentGroupList) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentGroupList"} + if s.Groups != nil { + for i, v := range s.Groups { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Groups", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetGroups sets the Groups field's value. func (s *SegmentGroupList) SetGroups(v []*SegmentGroup) *SegmentGroupList { s.Groups = v @@ -18571,32 +19870,49 @@ func (s *SegmentGroupList) SetInclude(v string) *SegmentGroupList { return s } -// Segment import definition. +// Provides information about the import job that created a segment. An import +// job is a job that creates a user segment by importing endpoint definitions. type SegmentImportResource struct { _ struct{} `type:"structure"` - // The number of channel types in the imported segment. + // The number of channel types in the endpoint definitions that were imported + // to create the segment. ChannelCounts map[string]*int64 `type:"map"` - // (Deprecated) Your AWS account ID, which you assigned to the ExternalID key - // in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This - // requirement is removed, and external IDs are not recommended for IAM roles - // assumed by Amazon Pinpoint. - ExternalId *string `type:"string"` + // (Deprecated) Your AWS account ID, which you assigned to an external ID key + // in an IAM trust policy. Amazon Pinpoint previously used this value to assume + // an IAM role when importing endpoint definitions, but we removed this requirement. + // We don't recommend use of external IDs for IAM roles that are assumed by + // Amazon Pinpoint. + // + // ExternalId is a required field + ExternalId *string `type:"string" required:"true"` - // The format of the endpoint files that were imported to create this segment.Valid - // values: CSV, JSON - Format *string `type:"string" enum:"Format"` + // The format of the files that were imported to create the segment. Valid values + // are: CSV, for comma-separated values format; and, JSON, for newline-delimited + // JSON format. + // + // Format is a required field + Format *string `type:"string" required:"true" enum:"Format"` - // The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint - // access to the endpoints in Amazon S3. - RoleArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location + // to import endpoint definitions from. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` - // The URL of the S3 bucket that the segment was imported from. - S3Url *string `type:"string"` + // The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the + // endpoint definitions were imported from to create the segment. + // + // S3Url is a required field + S3Url *string `type:"string" required:"true"` - // The number of endpoints that were successfully imported to create this segment. - Size *int64 `type:"integer"` + // The number of endpoint definitions that were imported successfully to create + // the segment. + // + // Size is a required field + Size *int64 `type:"integer" required:"true"` } // String returns the string representation @@ -18645,14 +19961,14 @@ func (s *SegmentImportResource) SetSize(v int64) *SegmentImportResource { return s } -// Segment location dimensions +// Specifies geographical dimension settings for a segment. type SegmentLocation struct { _ struct{} `type:"structure"` - // The country or region, in ISO 3166-1 alpha-2 format. + // The country or region code, in ISO 3166-1 alpha-2 format, for the segment. Country *SetDimension `type:"structure"` - // The GPS Point dimension. + // The GPS location and range for the segment. GPSPoint *GPSPointDimension `type:"structure"` } @@ -18666,6 +19982,26 @@ func (s SegmentLocation) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentLocation) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentLocation"} + if s.Country != nil { + if err := s.Country.Validate(); err != nil { + invalidParams.AddNested("Country", err.(request.ErrInvalidParams)) + } + } + if s.GPSPoint != nil { + if err := s.GPSPoint.Validate(); err != nil { + invalidParams.AddNested("GPSPoint", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetCountry sets the Country field's value. func (s *SegmentLocation) SetCountry(v *SetDimension) *SegmentLocation { s.Country = v @@ -18678,14 +20014,16 @@ func (s *SegmentLocation) SetGPSPoint(v *GPSPointDimension) *SegmentLocation { return s } -// Segment reference. +// Specifies the segment identifier and version of a segment. type SegmentReference struct { _ struct{} `type:"structure"` - // A unique identifier for the segment. - Id *string `type:"string"` + // The unique identifier for the segment. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // If specified contains a specific version of the segment included. + // The version number of the segment. Version *int64 `type:"integer"` } @@ -18699,6 +20037,19 @@ func (s SegmentReference) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SegmentReference) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SegmentReference"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetId sets the Id field's value. func (s *SegmentReference) SetId(v string) *SegmentReference { s.Id = &v @@ -18711,26 +20062,36 @@ func (s *SegmentReference) SetVersion(v int64) *SegmentReference { return s } -// Segment definition. +// Provides information about the configuration, dimension, and other settings +// for a segment. type SegmentResponse struct { _ struct{} `type:"structure"` - // The ID of the application that the segment applies to. - ApplicationId *string `type:"string"` + // The unique identifier for the application that the segment is associated + // with. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The arn for the segment. - Arn *string `type:"string"` + // The Amazon Resource Name (ARN) of the segment. + // + // Arn is a required field + Arn *string `type:"string" required:"true"` // The date and time when the segment was created. - CreationDate *string `type:"string"` + // + // CreationDate is a required field + CreationDate *string `type:"string" required:"true"` - // The segment dimensions attributes. + // The dimension settings for the segment. Dimensions *SegmentDimensions `type:"structure"` - // The unique segment ID. - Id *string `type:"string"` + // The unique identifier for the segment. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // The import job settings. + // The settings for the import job that's associated with the segment. ImportDefinition *SegmentImportResource `type:"structure"` // The date and time when the segment was last modified. @@ -18739,23 +20100,30 @@ type SegmentResponse struct { // The name of the segment. Name *string `type:"string"` - // A segment group, which consists of zero or more source segments, plus dimensions - // that are applied to those source segments. + // A list of one or more segment groups that apply to the segment. Each segment + // group consists of zero or more base segments and the dimensions that are + // applied to those base segments. SegmentGroups *SegmentGroupList `type:"structure"` - // The segment type:DIMENSIONAL - A dynamic segment built from selection criteria - // based on endpoint data reported by your app. You create this type of segment - // by using the segment builder in the Amazon Pinpoint console or by making - // a POST request to the segments resource.IMPORT - A static segment built from - // an imported set of endpoint definitions. You create this type of segment - // by importing a segment in the Amazon Pinpoint console or by making a POST - // request to the jobs/import resource. - SegmentType *string `type:"string" enum:"SegmentType"` + // The segment type. Valid values are: + // + // * DIMENSIONAL - A dynamic segment, which is a segment that uses selection + // criteria that you specify and is based on endpoint data that's reported + // by your app. Dynamic segments can change over time. + // + // * IMPORT - A static segment, which is a segment that uses selection criteria + // that you specify and is based on endpoint definitions that you import + // from a file. Imported segments are static; they don't change over time. + // + // SegmentType is a required field + SegmentType *string `type:"string" required:"true" enum:"SegmentType"` - // The Tags for the segment. + // A string-to-string map of key-value pairs that identifies the tags that are + // associated with the segment. Each tag consists of a required tag key and + // an associated tag value. Tags map[string]*string `locationName:"tags" type:"map"` - // The segment version number. + // The version number of the segment. Version *int64 `type:"integer"` } @@ -18841,15 +20209,19 @@ func (s *SegmentResponse) SetVersion(v int64) *SegmentResponse { return s } -// Segments in your account. +// Provides information about all the segments that are associated with an application. type SegmentsResponse struct { _ struct{} `type:"structure"` - // The list of segments. - Item []*SegmentResponse `type:"list"` + // An array of responses, one for each segment that's associated with the application + // (Segments resource) or each version of a segment that's associated with the + // application (Segment Versions resource). + // + // Item is a required field + Item []*SegmentResponse `type:"list" required:"true"` - // An identifier used to retrieve the next page of results. The token is null - // if no additional pages exist. + // The string to use in a subsequent request to get the next page of results + // in a paginated response. This value is null if there are no additional pages. NextToken *string `type:"string"` } @@ -18881,7 +20253,8 @@ type SendMessagesInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Send message request. + // Specifies the objects that define configuration and other settings for a + // message. // // MessageRequest is a required field MessageRequest *MessageRequest `type:"structure" required:"true"` @@ -18909,6 +20282,11 @@ func (s *SendMessagesInput) Validate() error { if s.MessageRequest == nil { invalidParams.Add(request.NewErrParamRequired("MessageRequest")) } + if s.MessageRequest != nil { + if err := s.MessageRequest.Validate(); err != nil { + invalidParams.AddNested("MessageRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -18931,7 +20309,8 @@ func (s *SendMessagesInput) SetMessageRequest(v *MessageRequest) *SendMessagesIn type SendMessagesOutput struct { _ struct{} `type:"structure" payload:"MessageResponse"` - // Send message response. + // Provides information about the results of a request to send a message to + // an endpoint address. // // MessageResponse is a required field MessageResponse *MessageResponse `type:"structure" required:"true"` @@ -18953,27 +20332,33 @@ func (s *SendMessagesOutput) SetMessageResponse(v *MessageResponse) *SendMessage return s } -// Send message request. +// Specifies the configuration and other settings for a message to send to all +// the endpoints that are associated with a list of users. type SendUsersMessageRequest struct { _ struct{} `type:"structure"` - // A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes - // to the data.pinpoint object in the body of the push notification payload. - // Amazon Pinpoint also provides these attributes in the events that it generates - // for users-messages deliveries. + // A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint + // adds these attributes to the data.pinpoint object in the body of the notification + // payload. Amazon Pinpoint also provides these attributes in the events that + // it generates for users-messages deliveries. Context map[string]*string `type:"map"` - // Message definitions for the default message and any messages that are tailored - // for specific channels. - MessageConfiguration *DirectMessageConfiguration `type:"structure"` + // The message definitions for the default message and any default messages + // that you defined for specific channels. + // + // MessageConfiguration is a required field + MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"` - // A unique ID that you can use to trace a message. This ID is visible to recipients. + // The unique identifier for tracing the message. This identifier is visible + // to message recipients. TraceId *string `type:"string"` - // A map that associates user IDs with EndpointSendConfiguration objects. Within - // an EndpointSendConfiguration object, you can tailor the message for a user - // by specifying message overrides or substitutions. - Users map[string]*EndpointSendConfiguration `type:"map"` + // A map that associates user IDs with EndpointSendConfiguration objects. You + // can use an EndpointSendConfiguration object to tailor the message for a user + // by specifying settings such as content overrides and message variables. + // + // Users is a required field + Users map[string]*EndpointSendConfiguration `type:"map" required:"true"` } // String returns the string representation @@ -18986,6 +20371,22 @@ func (s SendUsersMessageRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SendUsersMessageRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SendUsersMessageRequest"} + if s.MessageConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("MessageConfiguration")) + } + if s.Users == nil { + invalidParams.Add(request.NewErrParamRequired("Users")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetContext sets the Context field's value. func (s *SendUsersMessageRequest) SetContext(v map[string]*string) *SendUsersMessageRequest { s.Context = v @@ -19010,19 +20411,21 @@ func (s *SendUsersMessageRequest) SetUsers(v map[string]*EndpointSendConfigurati return s } -// User send message response. +// Provides information about which users and endpoints a message was sent to. type SendUsersMessageResponse struct { _ struct{} `type:"structure"` - // The unique ID of the Amazon Pinpoint project used to send the message. - ApplicationId *string `type:"string"` + // The unique identifier for the application that was used to send the message. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The unique ID assigned to the users-messages request. + // The unique identifier that was assigned to the message request. RequestId *string `type:"string"` - // An object that shows the endpoints that were messaged for each user. The - // object provides a list of user IDs. For each user ID, it provides the endpoint - // IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult + // An object that indicates which endpoints the message was sent to, for each + // user. The object lists user IDs and, for each user ID, provides the endpoint + // IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult // object. Result map[string]map[string]*EndpointMessageResult `type:"map"` } @@ -19061,7 +20464,8 @@ type SendUsersMessagesInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Send message request. + // Specifies the configuration and other settings for a message to send to all + // the endpoints that are associated with a list of users. // // SendUsersMessageRequest is a required field SendUsersMessageRequest *SendUsersMessageRequest `type:"structure" required:"true"` @@ -19089,6 +20493,11 @@ func (s *SendUsersMessagesInput) Validate() error { if s.SendUsersMessageRequest == nil { invalidParams.Add(request.NewErrParamRequired("SendUsersMessageRequest")) } + if s.SendUsersMessageRequest != nil { + if err := s.SendUsersMessageRequest.Validate(); err != nil { + invalidParams.AddNested("SendUsersMessageRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -19111,7 +20520,7 @@ func (s *SendUsersMessagesInput) SetSendUsersMessageRequest(v *SendUsersMessageR type SendUsersMessagesOutput struct { _ struct{} `type:"structure" payload:"SendUsersMessageResponse"` - // User send message response. + // Provides information about which users and endpoints a message was sent to. // // SendUsersMessageResponse is a required field SendUsersMessageResponse *SendUsersMessageResponse `type:"structure" required:"true"` @@ -19133,18 +20542,22 @@ func (s *SendUsersMessagesOutput) SetSendUsersMessageResponse(v *SendUsersMessag return s } -// Information about a session. +// Provides information about a session. type Session struct { _ struct{} `type:"structure"` // The duration of the session, in milliseconds. Duration *int64 `type:"integer"` - // A unique identifier for the session. - Id *string `type:"string"` + // The unique identifier for the session. + // + // Id is a required field + Id *string `type:"string" required:"true"` // The date and time when the session began. - StartTimestamp *string `type:"string"` + // + // StartTimestamp is a required field + StartTimestamp *string `type:"string" required:"true"` // The date and time when the session ended. StopTimestamp *string `type:"string"` @@ -19160,6 +20573,22 @@ func (s Session) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *Session) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Session"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.StartTimestamp == nil { + invalidParams.Add(request.NewErrParamRequired("StartTimestamp")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDuration sets the Duration field's value. func (s *Session) SetDuration(v int64) *Session { s.Duration = &v @@ -19184,19 +20613,21 @@ func (s *Session) SetStopTimestamp(v string) *Session { return s } -// Dimension specification of a segment. +// Specifies the dimension type and values for a segment dimension. type SetDimension struct { _ struct{} `type:"structure"` - // The type of dimension:INCLUSIVE - Endpoints that match the criteria are included - // in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded - // from the segment. + // The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints + // that match the criteria are included in the segment; and, EXCLUSIVE, endpoints + // that match the criteria are excluded from the segment. DimensionType *string `type:"string" enum:"DimensionType"` - // The criteria values for the segment dimension. Endpoints with matching attribute - // values are included or excluded from the segment, depending on the setting - // for Type. - Values []*string `type:"list"` + // The criteria values to use for the segment dimension. Depending on the value + // of the DimensionType property, endpoints are included or excluded from the + // segment if their values match the criteria values. + // + // Values is a required field + Values []*string `type:"list" required:"true"` } // String returns the string representation @@ -19209,6 +20640,19 @@ func (s SetDimension) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SetDimension) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SetDimension"} + if s.Values == nil { + invalidParams.Add(request.NewErrParamRequired("Values")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDimensionType sets the DimensionType field's value. func (s *SetDimension) SetDimensionType(v string) *SetDimension { s.DimensionType = &v @@ -19221,21 +20665,22 @@ func (s *SetDimension) SetValues(v []*string) *SetDimension { return s } -// An email composed of a subject, a text part and a html part. +// Specifies the content of an email message, composed of a subject, a text +// part, and an HTML part. type SimpleEmail struct { _ struct{} `type:"structure"` - // The content of the message, in HTML format. Use this for email clients that - // can process HTML. You can include clickable links, formatted text, and much - // more in an HTML message. + // The body of the email message, in HTML format. We recommend using an HTML + // part for email clients that support HTML. You can include links, formatted + // text, and more in an HTML message. HtmlPart *SimpleEmailPart `type:"structure"` - // The subject of the message: A short summary of the content, which will appear - // in the recipient's inbox. + // The subject line, or title, of the email. Subject *SimpleEmailPart `type:"structure"` - // The content of the message, in text format. Use this for text-based email - // clients, or clients on high-latency networks (such as mobile devices). + // The body of the email message, in text format. We recommend using a text + // part for email clients that don't support HTML and clients that are connected + // to high-latency networks, such as mobile devices. TextPart *SimpleEmailPart `type:"structure"` } @@ -19267,14 +20712,15 @@ func (s *SimpleEmail) SetTextPart(v *SimpleEmailPart) *SimpleEmail { return s } -// Textual email data, plus an optional character set specification. +// Specifies the subject or body of an email message, represented as textual +// email data and the applicable character set. type SimpleEmailPart struct { _ struct{} `type:"structure"` - // The character set of the content. + // The applicable character set for the message content. Charset *string `type:"string"` - // The textual data of the content. + // The textual data of the message content. Data *string `type:"string"` } @@ -19306,6 +20752,8 @@ type TagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"` + // Specifies the tags (keys and values) for an application, campaign, or segment. + // // TagsModel is a required field TagsModel *TagsModel `type:"structure" required:"true"` } @@ -19370,9 +20818,18 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// Specifies the tags (keys and values) for an application, campaign, or segment. type TagsModel struct { _ struct{} `type:"structure"` + // A string-to-string map of key-value pairs that defines the tags for an application, + // campaign, or segment. A project, campaign, or segment can have a maximum + // of 50 tags. + // + // Each tag consists of a required tag key and an associated tag value. The + // maximum length of a tag key is 128 characters. The maximum length of a tag + // value is 256 characters. + // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` } @@ -19406,29 +20863,36 @@ func (s *TagsModel) SetTags(v map[string]*string) *TagsModel { return s } -// Treatment resource +// Specifies the settings for a campaign treatment. A treatment is a variation +// of a campaign that's used for A/B testing of a campaign. type TreatmentResource struct { _ struct{} `type:"structure"` - // The unique treatment ID. - Id *string `type:"string"` + // The unique identifier for the treatment. + // + // Id is a required field + Id *string `type:"string" required:"true"` - // The message configuration settings. + // The message configuration settings for the treatment. MessageConfiguration *MessageConfiguration `type:"structure"` - // The campaign schedule. + // The schedule settings for the treatment. Schedule *Schedule `type:"structure"` - // The allocated percentage of users for this treatment. - SizePercent *int64 `type:"integer"` + // The allocated percentage of users (segment members) that the treatment is + // sent to. + // + // SizePercent is a required field + SizePercent *int64 `type:"integer" required:"true"` - // The treatment status. + // The status of the treatment. State *CampaignState `type:"structure"` - // A custom description for the treatment. + // The custom description of the treatment. TreatmentDescription *string `type:"string"` - // The custom name of a variation of the campaign used for A/B testing. + // The custom name of the treatment. A treatment is a variation of a campaign + // that's used for A/B testing of a campaign. TreatmentName *string `type:"string"` } @@ -19552,7 +21016,8 @@ func (s UntagResourceOutput) GoString() string { type UpdateAdmChannelInput struct { _ struct{} `type:"structure" payload:"ADMChannelRequest"` - // Amazon Device Messaging channel definition. + // Specifies the status and settings of the ADM (Amazon Device Messaging) channel + // for an application. // // ADMChannelRequest is a required field ADMChannelRequest *ADMChannelRequest `type:"structure" required:"true"` @@ -19583,6 +21048,11 @@ func (s *UpdateAdmChannelInput) Validate() error { if s.ApplicationId != nil && len(*s.ApplicationId) < 1 { invalidParams.Add(request.NewErrParamMinLen("ApplicationId", 1)) } + if s.ADMChannelRequest != nil { + if err := s.ADMChannelRequest.Validate(); err != nil { + invalidParams.AddNested("ADMChannelRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -19605,7 +21075,8 @@ func (s *UpdateAdmChannelInput) SetApplicationId(v string) *UpdateAdmChannelInpu type UpdateAdmChannelOutput struct { _ struct{} `type:"structure" payload:"ADMChannelResponse"` - // Amazon Device Messaging channel definition. + // Provides information about the status and settings of the ADM (Amazon Device + // Messaging) channel for an application. // // ADMChannelResponse is a required field ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"` @@ -19630,7 +21101,8 @@ func (s *UpdateAdmChannelOutput) SetADMChannelResponse(v *ADMChannelResponse) *U type UpdateApnsChannelInput struct { _ struct{} `type:"structure" payload:"APNSChannelRequest"` - // Apple Push Notification Service channel definition. + // Specifies the status and settings of the APNs (Apple Push Notification service) + // channel for an application. // // APNSChannelRequest is a required field APNSChannelRequest *APNSChannelRequest `type:"structure" required:"true"` @@ -19683,7 +21155,8 @@ func (s *UpdateApnsChannelInput) SetApplicationId(v string) *UpdateApnsChannelIn type UpdateApnsChannelOutput struct { _ struct{} `type:"structure" payload:"APNSChannelResponse"` - // Apple Distribution Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) channel for an application. // // APNSChannelResponse is a required field APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"` @@ -19708,7 +21181,8 @@ func (s *UpdateApnsChannelOutput) SetAPNSChannelResponse(v *APNSChannelResponse) type UpdateApnsSandboxChannelInput struct { _ struct{} `type:"structure" payload:"APNSSandboxChannelRequest"` - // Apple Development Push Notification Service channel definition. + // Specifies the status and settings of the APNs (Apple Push Notification service) + // sandbox channel for an application. // // APNSSandboxChannelRequest is a required field APNSSandboxChannelRequest *APNSSandboxChannelRequest `type:"structure" required:"true"` @@ -19761,7 +21235,8 @@ func (s *UpdateApnsSandboxChannelInput) SetApplicationId(v string) *UpdateApnsSa type UpdateApnsSandboxChannelOutput struct { _ struct{} `type:"structure" payload:"APNSSandboxChannelResponse"` - // Apple Development Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) sandbox channel for an application. // // APNSSandboxChannelResponse is a required field APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"` @@ -19786,7 +21261,8 @@ func (s *UpdateApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSa type UpdateApnsVoipChannelInput struct { _ struct{} `type:"structure" payload:"APNSVoipChannelRequest"` - // Apple VoIP Push Notification Service channel definition. + // Specifies the status and settings of the APNs (Apple Push Notification service) + // VoIP channel for an application. // // APNSVoipChannelRequest is a required field APNSVoipChannelRequest *APNSVoipChannelRequest `type:"structure" required:"true"` @@ -19839,7 +21315,8 @@ func (s *UpdateApnsVoipChannelInput) SetApplicationId(v string) *UpdateApnsVoipC type UpdateApnsVoipChannelOutput struct { _ struct{} `type:"structure" payload:"APNSVoipChannelResponse"` - // Apple VoIP Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) VoIP channel for an application. // // APNSVoipChannelResponse is a required field APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"` @@ -19864,7 +21341,8 @@ func (s *UpdateApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChan type UpdateApnsVoipSandboxChannelInput struct { _ struct{} `type:"structure" payload:"APNSVoipSandboxChannelRequest"` - // Apple VoIP Developer Push Notification Service channel definition. + // Specifies the status and settings of the APNs (Apple Push Notification service) + // VoIP sandbox channel for an application. // // APNSVoipSandboxChannelRequest is a required field APNSVoipSandboxChannelRequest *APNSVoipSandboxChannelRequest `type:"structure" required:"true"` @@ -19917,7 +21395,8 @@ func (s *UpdateApnsVoipSandboxChannelInput) SetApplicationId(v string) *UpdateAp type UpdateApnsVoipSandboxChannelOutput struct { _ struct{} `type:"structure" payload:"APNSVoipSandboxChannelResponse"` - // Apple VoIP Developer Push Notification Service channel definition. + // Provides information about the status and settings of the APNs (Apple Push + // Notification service) VoIP sandbox channel for an application. // // APNSVoipSandboxChannelResponse is a required field APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"` @@ -19945,7 +21424,7 @@ type UpdateApplicationSettingsInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Creating application setting request + // Specifies the default settings for an application. // // WriteApplicationSettingsRequest is a required field WriteApplicationSettingsRequest *WriteApplicationSettingsRequest `type:"structure" required:"true"` @@ -19995,7 +21474,8 @@ func (s *UpdateApplicationSettingsInput) SetWriteApplicationSettingsRequest(v *W type UpdateApplicationSettingsOutput struct { _ struct{} `type:"structure" payload:"ApplicationSettingsResource"` - // Application settings. + // Provides information about an application, including the default settings + // for an application. // // ApplicationSettingsResource is a required field ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"` @@ -20017,11 +21497,15 @@ func (s *UpdateApplicationSettingsOutput) SetApplicationSettingsResource(v *Appl return s } -// Update attributes request +// Specifies one or more attributes to remove from all the endpoints that are +// associated with an application. type UpdateAttributesRequest struct { _ struct{} `type:"structure"` - // The GLOB wildcard for removing the attributes in the application + // An array of the attributes to remove from all the endpoints that are associated + // with the application. The array can specify the complete, exact name of each + // attribute to remove or it can specify a glob pattern that an attribute name + // must match in order for the attribute to be removed. Blacklist []*string `type:"list"` } @@ -20047,7 +21531,8 @@ type UpdateBaiduChannelInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Baidu Cloud Push credentials + // Specifies the status and settings of the Baidu (Baidu Cloud Push) channel + // for an application. // // BaiduChannelRequest is a required field BaiduChannelRequest *BaiduChannelRequest `type:"structure" required:"true"` @@ -20075,6 +21560,11 @@ func (s *UpdateBaiduChannelInput) Validate() error { if s.BaiduChannelRequest == nil { invalidParams.Add(request.NewErrParamRequired("BaiduChannelRequest")) } + if s.BaiduChannelRequest != nil { + if err := s.BaiduChannelRequest.Validate(); err != nil { + invalidParams.AddNested("BaiduChannelRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20097,7 +21587,8 @@ func (s *UpdateBaiduChannelInput) SetBaiduChannelRequest(v *BaiduChannelRequest) type UpdateBaiduChannelOutput struct { _ struct{} `type:"structure" payload:"BaiduChannelResponse"` - // Baidu Cloud Messaging channel definition + // Provides information about the status and settings of the Baidu (Baidu Cloud + // Push) channel for an application. // // BaiduChannelResponse is a required field BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"` @@ -20128,7 +21619,7 @@ type UpdateCampaignInput struct { // CampaignId is a required field CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"` - // Used to create a campaign. + // Specifies the configuration and other settings for a campaign. // // WriteCampaignRequest is a required field WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"` @@ -20162,6 +21653,11 @@ func (s *UpdateCampaignInput) Validate() error { if s.WriteCampaignRequest == nil { invalidParams.Add(request.NewErrParamRequired("WriteCampaignRequest")) } + if s.WriteCampaignRequest != nil { + if err := s.WriteCampaignRequest.Validate(); err != nil { + invalidParams.AddNested("WriteCampaignRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20190,7 +21686,8 @@ func (s *UpdateCampaignInput) SetWriteCampaignRequest(v *WriteCampaignRequest) * type UpdateCampaignOutput struct { _ struct{} `type:"structure" payload:"CampaignResponse"` - // Campaign definition + // Provides information about the status, configuration, and other settings + // for a campaign. // // CampaignResponse is a required field CampaignResponse *CampaignResponse `type:"structure" required:"true"` @@ -20218,7 +21715,7 @@ type UpdateEmailChannelInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Email Channel Request + // Specifies the status and settings of the email channel for an application. // // EmailChannelRequest is a required field EmailChannelRequest *EmailChannelRequest `type:"structure" required:"true"` @@ -20246,6 +21743,11 @@ func (s *UpdateEmailChannelInput) Validate() error { if s.EmailChannelRequest == nil { invalidParams.Add(request.NewErrParamRequired("EmailChannelRequest")) } + if s.EmailChannelRequest != nil { + if err := s.EmailChannelRequest.Validate(); err != nil { + invalidParams.AddNested("EmailChannelRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20268,7 +21770,8 @@ func (s *UpdateEmailChannelInput) SetEmailChannelRequest(v *EmailChannelRequest) type UpdateEmailChannelOutput struct { _ struct{} `type:"structure" payload:"EmailChannelResponse"` - // Email Channel Response. + // Provides information about the status and settings of the email channel for + // an application. // // EmailChannelResponse is a required field EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"` @@ -20299,7 +21802,7 @@ type UpdateEndpointInput struct { // EndpointId is a required field EndpointId *string `location:"uri" locationName:"endpoint-id" type:"string" required:"true"` - // An endpoint update request. + // Specifies the channel type and other settings for an endpoint. // // EndpointRequest is a required field EndpointRequest *EndpointRequest `type:"structure" required:"true"` @@ -20361,7 +21864,7 @@ func (s *UpdateEndpointInput) SetEndpointRequest(v *EndpointRequest) *UpdateEndp type UpdateEndpointOutput struct { _ struct{} `type:"structure" payload:"MessageBody"` - // Simple message object. + // Provides information about an API request or response. // // MessageBody is a required field MessageBody *MessageBody `type:"structure" required:"true"` @@ -20389,7 +21892,8 @@ type UpdateEndpointsBatchInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Endpoint batch update request. + // Specifies a batch of endpoints to create or update and the settings and attributes + // to set or change for each endpoint. // // EndpointBatchRequest is a required field EndpointBatchRequest *EndpointBatchRequest `type:"structure" required:"true"` @@ -20417,6 +21921,11 @@ func (s *UpdateEndpointsBatchInput) Validate() error { if s.EndpointBatchRequest == nil { invalidParams.Add(request.NewErrParamRequired("EndpointBatchRequest")) } + if s.EndpointBatchRequest != nil { + if err := s.EndpointBatchRequest.Validate(); err != nil { + invalidParams.AddNested("EndpointBatchRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20439,7 +21948,7 @@ func (s *UpdateEndpointsBatchInput) SetEndpointBatchRequest(v *EndpointBatchRequ type UpdateEndpointsBatchOutput struct { _ struct{} `type:"structure" payload:"MessageBody"` - // Simple message object. + // Provides information about an API request or response. // // MessageBody is a required field MessageBody *MessageBody `type:"structure" required:"true"` @@ -20467,7 +21976,9 @@ type UpdateGcmChannelInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Google Cloud Messaging credentials + // Specifies the status and settings of the GCM channel for an application. + // This channel enables Amazon Pinpoint to send push notifications through the + // Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. // // GCMChannelRequest is a required field GCMChannelRequest *GCMChannelRequest `type:"structure" required:"true"` @@ -20495,6 +22006,11 @@ func (s *UpdateGcmChannelInput) Validate() error { if s.GCMChannelRequest == nil { invalidParams.Add(request.NewErrParamRequired("GCMChannelRequest")) } + if s.GCMChannelRequest != nil { + if err := s.GCMChannelRequest.Validate(); err != nil { + invalidParams.AddNested("GCMChannelRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20517,7 +22033,10 @@ func (s *UpdateGcmChannelInput) SetGCMChannelRequest(v *GCMChannelRequest) *Upda type UpdateGcmChannelOutput struct { _ struct{} `type:"structure" payload:"GCMChannelResponse"` - // Google Cloud Messaging channel definition + // Provides information about the status and settings of the GCM channel for + // an application. The GCM channel enables Amazon Pinpoint to send push notifications + // through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging + // (GCM), service. // // GCMChannelResponse is a required field GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"` @@ -20548,7 +22067,9 @@ type UpdateSegmentInput struct { // SegmentId is a required field SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"` - // Segment definition. + // Specifies the configuration, dimension, and other settings for a segment. + // A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups + // object, but not both. // // WriteSegmentRequest is a required field WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"` @@ -20582,6 +22103,11 @@ func (s *UpdateSegmentInput) Validate() error { if s.WriteSegmentRequest == nil { invalidParams.Add(request.NewErrParamRequired("WriteSegmentRequest")) } + if s.WriteSegmentRequest != nil { + if err := s.WriteSegmentRequest.Validate(); err != nil { + invalidParams.AddNested("WriteSegmentRequest", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20610,7 +22136,8 @@ func (s *UpdateSegmentInput) SetWriteSegmentRequest(v *WriteSegmentRequest) *Upd type UpdateSegmentOutput struct { _ struct{} `type:"structure" payload:"SegmentResponse"` - // Segment definition. + // Provides information about the configuration, dimension, and other settings + // for a segment. // // SegmentResponse is a required field SegmentResponse *SegmentResponse `type:"structure" required:"true"` @@ -20638,7 +22165,7 @@ type UpdateSmsChannelInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // SMS Channel Request + // Specifies the status and settings of the SMS channel for an application. // // SMSChannelRequest is a required field SMSChannelRequest *SMSChannelRequest `type:"structure" required:"true"` @@ -20688,7 +22215,8 @@ func (s *UpdateSmsChannelInput) SetSMSChannelRequest(v *SMSChannelRequest) *Upda type UpdateSmsChannelOutput struct { _ struct{} `type:"structure" payload:"SMSChannelResponse"` - // SMS Channel Response. + // Provides information about the status and settings of the SMS channel for + // an application. // // SMSChannelResponse is a required field SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"` @@ -20716,7 +22244,7 @@ type UpdateVoiceChannelInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"` - // Voice Channel Request + // Specifies the status and settings of the voice channel for an application. // // VoiceChannelRequest is a required field VoiceChannelRequest *VoiceChannelRequest `type:"structure" required:"true"` @@ -20766,7 +22294,8 @@ func (s *UpdateVoiceChannelInput) SetVoiceChannelRequest(v *VoiceChannelRequest) type UpdateVoiceChannelOutput struct { _ struct{} `type:"structure" payload:"VoiceChannelResponse"` - // Voice Channel Response. + // Provides information about the status and settings of the voice channel for + // an application. // // VoiceChannelResponse is a required field VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"` @@ -20788,11 +22317,11 @@ func (s *UpdateVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelRespon return s } -// Voice Channel Request +// Specifies the status and settings of the voice channel for an application. type VoiceChannelRequest struct { _ struct{} `type:"structure"` - // If the channel is enabled for sending messages. + // Specifies whether to enable the voice channel for the application. Enabled *bool `type:"boolean"` } @@ -20812,37 +22341,44 @@ func (s *VoiceChannelRequest) SetEnabled(v bool) *VoiceChannelRequest { return s } -// Voice Channel Response. +// Provides information about the status and settings of the voice channel for +// an application. type VoiceChannelResponse struct { _ struct{} `type:"structure"` - // Application id + // The unique identifier for the application that the voice channel applies + // to. ApplicationId *string `type:"string"` - // The date that the settings were last updated in ISO 8601 format. + // The date and time, in ISO 8601 format, when the voice channel was enabled. CreationDate *string `type:"string"` - // If the channel is enabled for sending messages. + // Specifies whether the voice channel is enabled for the application. Enabled *bool `type:"boolean"` + // (Not used) This property is retained only for backward compatibility. HasCredential *bool `type:"boolean"` - // Channel ID. Not used, only for backwards compatibility. + // (Deprecated) An identifier for the voice channel. This property is retained + // only for backward compatibility. Id *string `type:"string"` - // Is this channel archived + // Specifies whether the voice channel is archived. IsArchived *bool `type:"boolean"` - // Who made the last change + // The user who last modified the voice channel. LastModifiedBy *string `type:"string"` - // Last date this was updated + // The date and time, in ISO 8601 format, when the voice channel was last modified. LastModifiedDate *string `type:"string"` - // Platform type. Will be "Voice" - Platform *string `type:"string"` + // The type of messaging or notification platform for the channel. For the voice + // channel, this value is VOICE. + // + // Platform is a required field + Platform *string `type:"string" required:"true"` - // Version of channel + // The current version of the voice channel. Version *int64 `type:"integer"` } @@ -20916,23 +22452,29 @@ func (s *VoiceChannelResponse) SetVersion(v int64) *VoiceChannelResponse { return s } -// Voice Message. +// Specifies the settings for a one-time voice message that's sent directly +// to an endpoint through the voice channel. type VoiceMessage struct { _ struct{} `type:"structure"` - // The message body of the notification, the email body or the text message. + // The text script for the voice message. Body *string `type:"string"` - // Language of sent message + // The language to use when delivering the message. For a list of supported + // languages, see the Amazon Polly Developer Guide (AmazonPollyDG.html). LanguageCode *string `type:"string"` - // Is the number from the pool or messaging service to send from. + // The phone number from the pool or messaging service to send the message from. + // Although it isn't required, we recommend that you specify the phone number + // in E.164 format to ensure prompt and accurate delivery. OriginationNumber *string `type:"string"` - // Default message substitutions. Can be overridden by individual address substitutions. + // The default message variables to use in the voice message. You can override + // the default variables with individual address variables. Substitutions map[string][]*string `type:"map"` - // Voice ID of sent message. + // The name of the voice to use when delivering the message. For a list of supported + // voices, see the Amazon Polly Developer Guide (AmazonPollyDG.html). VoiceId *string `type:"string"` } @@ -20976,35 +22518,44 @@ func (s *VoiceMessage) SetVoiceId(v string) *VoiceMessage { return s } -// Creating application setting request +// Specifies the default settings for an application. type WriteApplicationSettingsRequest struct { _ struct{} `type:"structure"` - // Default campaign hook information. + // The settings for the AWS Lambda function to use by default as a code hook + // for campaigns in the application. To override these settings for a specific + // campaign, use the Campaign resource to define custom Lambda function settings + // for the campaign. CampaignHook *CampaignHook `type:"structure"` - // The CloudWatchMetrics settings for the app. + // Specifies whether to enable application-related alarms in Amazon CloudWatch. CloudWatchMetricsEnabled *bool `type:"boolean"` - // The limits that apply to each campaign in the project by default. Campaigns - // can also have their own limits, which override the settings at the project - // level. + // The default sending limits for campaigns in the application. To override + // these limits for a specific campaign, use the Campaign resource to define + // custom limits for the campaign. Limits *CampaignLimits `type:"structure"` - // The default quiet time for the app. Campaigns in the app don't send messages - // to endpoints during the quiet time.Note: Make sure that your endpoints include - // the Demographics.Timezone attribute if you plan to enable a quiet time for - // your app. If your endpoints don't include this attribute, they'll receive - // the messages that you send them, even if quiet time is enabled.When you set - // up an app to use quiet time, campaigns in that app don't send messages during - // the time range you specified, as long as all of the following are true:- - // The endpoint includes a valid Demographic.Timezone attribute.- The current - // time in the endpoint's time zone is later than or equal to the time specified - // in the QuietTime.Start attribute for the app (or campaign, if applicable).- - // The current time in the endpoint's time zone is earlier than or equal to - // the time specified in the QuietTime.End attribute for the app (or campaign, - // if applicable).Individual campaigns within the app can have their own quiet - // time settings, which override the quiet time settings at the app level. + // The default quiet time for campaigns in the application. Quiet time is a + // specific time range when campaigns don't send messages to endpoints, if all + // the following conditions are met: + // + // * The EndpointDemographic.Timezone property of the endpoint is set to + // a valid value. + // + // * The current time in the endpoint's time zone is later than or equal + // to the time specified by the QuietTime.Start property for the application + // (or a campaign that has custom quiet time settings). + // + // * The current time in the endpoint's time zone is earlier than or equal + // to the time specified by the QuietTime.End property for the application + // (or a campaign that has custom quiet time settings). + // + // If any of the preceding conditions isn't met, the endpoint will receive messages + // from a campaign, even if quiet time is enabled. + // + // To override the default quiet time settings for a specific campaign, use + // the Campaign resource to define a custom quiet time for the campaign. QuietTime *QuietTime `type:"structure"` } @@ -21042,52 +22593,55 @@ func (s *WriteApplicationSettingsRequest) SetQuietTime(v *QuietTime) *WriteAppli return s } -// Used to create a campaign. +// Specifies the configuration and other settings for a campaign. type WriteCampaignRequest struct { _ struct{} `type:"structure"` - // Treatments that are defined in addition to the default treatment. + // An array of requests that defines additional treatments for the campaign, + // in addition to the default treatment for the campaign. AdditionalTreatments []*WriteTreatmentResource `type:"list"` - // A description of the campaign. + // The custom description of the campaign. Description *string `type:"string"` - // The allocated percentage of end users who will not receive messages from - // this campaign. + // The allocated percentage of users (segment members) who shouldn't receive + // messages from the campaign. HoldoutPercent *int64 `type:"integer"` - // Campaign hook information. + // The settings for the AWS Lambda function to use as a code hook for the campaign. Hook *CampaignHook `type:"structure"` - // Indicates whether the campaign is paused. A paused campaign does not send - // messages unless you resume it by setting IsPaused to false. + // Specifies whether to pause the campaign. A paused campaign doesn't run unless + // you resume it by setting this value to false. IsPaused *bool `type:"boolean"` - // The campaign limits settings. + // The messaging limits for the campaign. Limits *CampaignLimits `type:"structure"` - // The message configuration settings. + // The message configuration settings for the campaign. MessageConfiguration *MessageConfiguration `type:"structure"` // The custom name of the campaign. Name *string `type:"string"` - // The campaign schedule. + // The schedule settings for the campaign. Schedule *Schedule `type:"structure"` - // The ID of the segment to which the campaign sends messages. + // The unique identifier for the segment to associate with the campaign. SegmentId *string `type:"string"` - // The version of the segment to which the campaign sends messages. + // The version of the segment to associate with the campaign. SegmentVersion *int64 `type:"integer"` - // The Tags for the campaign. + // A string-to-string map of key-value pairs that defines the tags to associate + // with the campaign. Each tag consists of a required tag key and an associated + // tag value. Tags map[string]*string `locationName:"tags" type:"map"` - // A custom description for the treatment. + // The custom description of a variation of the campaign to use for A/B testing. TreatmentDescription *string `type:"string"` - // The custom name of a variation of the campaign used for A/B testing. + // The custom name of a variation of the campaign to use for A/B testing. TreatmentName *string `type:"string"` } @@ -21101,6 +22655,36 @@ func (s WriteCampaignRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *WriteCampaignRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WriteCampaignRequest"} + if s.AdditionalTreatments != nil { + for i, v := range s.AdditionalTreatments { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AdditionalTreatments", i), err.(request.ErrInvalidParams)) + } + } + } + if s.MessageConfiguration != nil { + if err := s.MessageConfiguration.Validate(); err != nil { + invalidParams.AddNested("MessageConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Schedule != nil { + if err := s.Schedule.Validate(); err != nil { + invalidParams.AddNested("Schedule", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAdditionalTreatments sets the AdditionalTreatments field's value. func (s *WriteCampaignRequest) SetAdditionalTreatments(v []*WriteTreatmentResource) *WriteCampaignRequest { s.AdditionalTreatments = v @@ -21185,18 +22769,28 @@ func (s *WriteCampaignRequest) SetTreatmentName(v string) *WriteCampaignRequest return s } -// Request to save an EventStream. +// Specifies the Amazon Resource Name (ARN) of an event stream to publish events +// to and the AWS Identity and Access Management (IAM) role to use when publishing +// those events. type WriteEventStream struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery - // stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME - // Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME - DestinationStreamArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon + // Kinesis Data Firehose delivery stream that you want to publish event data + // to. + // + // For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name + // + // For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name + // + // DestinationStreamArn is a required field + DestinationStreamArn *string `type:"string" required:"true"` - // The IAM role that authorizes Amazon Pinpoint to publish events to the stream - // in your account. - RoleArn *string `type:"string"` + // The AWS Identity and Access Management (IAM) role that authorizes Amazon + // Pinpoint to publish event data to the stream in your AWS account. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` } // String returns the string representation @@ -21209,6 +22803,22 @@ func (s WriteEventStream) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *WriteEventStream) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WriteEventStream"} + if s.DestinationStreamArn == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationStreamArn")) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDestinationStreamArn sets the DestinationStreamArn field's value. func (s *WriteEventStream) SetDestinationStreamArn(v string) *WriteEventStream { s.DestinationStreamArn = &v @@ -21221,23 +22831,26 @@ func (s *WriteEventStream) SetRoleArn(v string) *WriteEventStream { return s } -// Segment definition. +// Specifies the configuration, dimension, and other settings for a segment. +// A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups +// object, but not both. type WriteSegmentRequest struct { _ struct{} `type:"structure"` - // The segment dimensions attributes. + // The criteria that define the dimensions for the segment. Dimensions *SegmentDimensions `type:"structure"` - // The name of segment + // The name of the segment. Name *string `type:"string"` - // A segment group, which consists of zero or more source segments, plus dimensions - // that are applied to those source segments. Your request can only include - // one segment group. Your request can include either a SegmentGroups object - // or a Dimensions object, but not both. + // The segment group to use and the dimensions to apply to the group's base + // segments in order to build the segment. A segment group can consist of zero + // or more base segments. Your request can include only one segment group. SegmentGroups *SegmentGroupList `type:"structure"` - // The Tags for the segments. + // A string-to-string map of key-value pairs that defines the tags to associate + // with the segment. Each tag consists of a required tag key and an associated + // tag value. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -21251,6 +22864,26 @@ func (s WriteSegmentRequest) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *WriteSegmentRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WriteSegmentRequest"} + if s.Dimensions != nil { + if err := s.Dimensions.Validate(); err != nil { + invalidParams.AddNested("Dimensions", err.(request.ErrInvalidParams)) + } + } + if s.SegmentGroups != nil { + if err := s.SegmentGroups.Validate(); err != nil { + invalidParams.AddNested("SegmentGroups", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDimensions sets the Dimensions field's value. func (s *WriteSegmentRequest) SetDimensions(v *SegmentDimensions) *WriteSegmentRequest { s.Dimensions = v @@ -21275,23 +22908,28 @@ func (s *WriteSegmentRequest) SetTags(v map[string]*string) *WriteSegmentRequest return s } -// Used to create a campaign treatment. +// Specifies the settings for a campaign treatment. A treatment is a variation +// of a campaign that's used for A/B testing of a campaign. type WriteTreatmentResource struct { _ struct{} `type:"structure"` - // The message configuration settings. + // The message configuration settings for the treatment. MessageConfiguration *MessageConfiguration `type:"structure"` - // The campaign schedule. + // The schedule settings for the treatment. Schedule *Schedule `type:"structure"` - // The allocated percentage of users for this treatment. - SizePercent *int64 `type:"integer"` + // The allocated percentage of users (segment members) to send the treatment + // to. + // + // SizePercent is a required field + SizePercent *int64 `type:"integer" required:"true"` - // A custom description for the treatment. + // The custom description of the treatment. TreatmentDescription *string `type:"string"` - // The custom name of a variation of the campaign used for A/B testing. + // The custom name of the treatment. A treatment is a variation of a campaign + // that's used for A/B testing of a campaign. TreatmentName *string `type:"string"` } @@ -21305,6 +22943,29 @@ func (s WriteTreatmentResource) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *WriteTreatmentResource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WriteTreatmentResource"} + if s.SizePercent == nil { + invalidParams.Add(request.NewErrParamRequired("SizePercent")) + } + if s.MessageConfiguration != nil { + if err := s.MessageConfiguration.Validate(); err != nil { + invalidParams.AddNested("MessageConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Schedule != nil { + if err := s.Schedule.Validate(); err != nil { + invalidParams.AddNested("Schedule", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetMessageConfiguration sets the MessageConfiguration field's value. func (s *WriteTreatmentResource) SetMessageConfiguration(v *MessageConfiguration) *WriteTreatmentResource { s.MessageConfiguration = v diff --git a/vendor/github.com/aws/aws-sdk-go/service/pinpoint/doc.go b/vendor/github.com/aws/aws-sdk-go/service/pinpoint/doc.go index f41551af66e..93d640dfb7c 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/pinpoint/doc.go +++ b/vendor/github.com/aws/aws-sdk-go/service/pinpoint/doc.go @@ -3,6 +3,8 @@ // Package pinpoint provides the client and types for making API // requests to Amazon Pinpoint. // +// Doc Engage API - Amazon Pinpoint API +// // See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01 for more information on this service. // // See pinpoint package documentation for more information. diff --git a/vendor/github.com/aws/aws-sdk-go/service/pinpoint/errors.go b/vendor/github.com/aws/aws-sdk-go/service/pinpoint/errors.go index 7bd7525b6a6..e70fd0b8bf9 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/pinpoint/errors.go +++ b/vendor/github.com/aws/aws-sdk-go/service/pinpoint/errors.go @@ -7,36 +7,36 @@ const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". // - // Simple message object. + // Provides information about an API request or response. ErrCodeBadRequestException = "BadRequestException" // ErrCodeForbiddenException for service response error code // "ForbiddenException". // - // Simple message object. + // Provides information about an API request or response. ErrCodeForbiddenException = "ForbiddenException" // ErrCodeInternalServerErrorException for service response error code // "InternalServerErrorException". // - // Simple message object. + // Provides information about an API request or response. ErrCodeInternalServerErrorException = "InternalServerErrorException" // ErrCodeMethodNotAllowedException for service response error code // "MethodNotAllowedException". // - // Simple message object. + // Provides information about an API request or response. ErrCodeMethodNotAllowedException = "MethodNotAllowedException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // - // Simple message object. + // Provides information about an API request or response. ErrCodeNotFoundException = "NotFoundException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // - // Simple message object. + // Provides information about an API request or response. ErrCodeTooManyRequestsException = "TooManyRequestsException" ) diff --git a/vendor/github.com/aws/aws-sdk-go/service/redshift/api.go b/vendor/github.com/aws/aws-sdk-go/service/redshift/api.go index a8ce97a6fd6..f728da8cab6 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/redshift/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/redshift/api.go @@ -8144,6 +8144,12 @@ func (c *Redshift) RestoreFromClusterSnapshotRequest(input *RestoreFromClusterSn // * ErrCodeSnapshotScheduleNotFoundFault "SnapshotScheduleNotFound" // We could not find the specified snapshot schedule. // +// * ErrCodeTagLimitExceededFault "TagLimitExceededFault" +// You have exceeded the number of tags allowed. +// +// * ErrCodeInvalidTagFault "InvalidTagFault" +// The tag is invalid. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreFromClusterSnapshot func (c *Redshift) RestoreFromClusterSnapshot(input *RestoreFromClusterSnapshotInput) (*RestoreFromClusterSnapshotOutput, error) { req, out := c.RestoreFromClusterSnapshotRequest(input) @@ -9346,6 +9352,22 @@ type Cluster struct { // The name of the Availability Zone in which the cluster is located. AvailabilityZone *string `type:"string"` + // The availability status of the cluster for queries. Possible values are the + // following: + // + // * Available - The cluster is available for queries. + // + // * Unavailable - The cluster is not available for queries. + // + // * Maintenance - The cluster is intermittently available for queries due + // to maintenance activities. + // + // * Modifying - The cluster is intermittently available for queries due + // to changes that modify the cluster. + // + // * Failed - The cluster failed and is not available for queries. + ClusterAvailabilityStatus *string `type:"string"` + // The date and time that the cluster was created. ClusterCreateTime *time.Time `type:"timestamp"` @@ -9574,6 +9596,12 @@ func (s *Cluster) SetAvailabilityZone(v string) *Cluster { return s } +// SetClusterAvailabilityStatus sets the ClusterAvailabilityStatus field's value. +func (s *Cluster) SetClusterAvailabilityStatus(v string) *Cluster { + s.ClusterAvailabilityStatus = &v + return s +} + // SetClusterCreateTime sets the ClusterCreateTime field's value. func (s *Cluster) SetClusterCreateTime(v time.Time) *Cluster { s.ClusterCreateTime = &v diff --git a/vendor/github.com/aws/aws-sdk-go/service/workspaces/api.go b/vendor/github.com/aws/aws-sdk-go/service/workspaces/api.go index 08f2b50105e..30a4ae87546 100644 --- a/vendor/github.com/aws/aws-sdk-go/service/workspaces/api.go +++ b/vendor/github.com/aws/aws-sdk-go/service/workspaces/api.go @@ -203,6 +203,103 @@ func (c *WorkSpaces) AuthorizeIpRulesWithContext(ctx aws.Context, input *Authori return out, req.Send() } +const opCopyWorkspaceImage = "CopyWorkspaceImage" + +// CopyWorkspaceImageRequest generates a "aws/request.Request" representing the +// client's request for the CopyWorkspaceImage 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 CopyWorkspaceImage for more information on using the CopyWorkspaceImage +// 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 CopyWorkspaceImageRequest method. +// req, resp := client.CopyWorkspaceImageRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CopyWorkspaceImage +func (c *WorkSpaces) CopyWorkspaceImageRequest(input *CopyWorkspaceImageInput) (req *request.Request, output *CopyWorkspaceImageOutput) { + op := &request.Operation{ + Name: opCopyWorkspaceImage, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CopyWorkspaceImageInput{} + } + + output = &CopyWorkspaceImageOutput{} + req = c.newRequest(op, input, output) + return +} + +// CopyWorkspaceImage API operation for Amazon WorkSpaces. +// +// Copies the specified image from the specified Region to the current Region. +// +// 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 WorkSpaces's +// API operation CopyWorkspaceImage for usage and error information. +// +// Returned Error Codes: +// * ErrCodeResourceLimitExceededException "ResourceLimitExceededException" +// Your resource limits have been exceeded. +// +// * ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" +// The specified resource already exists. +// +// * ErrCodeResourceNotFoundException "ResourceNotFoundException" +// The resource could not be found. +// +// * ErrCodeResourceUnavailableException "ResourceUnavailableException" +// The specified resource is not available. +// +// * ErrCodeOperationNotSupportedException "OperationNotSupportedException" +// This operation is not supported. +// +// * ErrCodeAccessDeniedException "AccessDeniedException" +// The user is not authorized to access a resource. +// +// * ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" +// One or more parameter values are not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CopyWorkspaceImage +func (c *WorkSpaces) CopyWorkspaceImage(input *CopyWorkspaceImageInput) (*CopyWorkspaceImageOutput, error) { + req, out := c.CopyWorkspaceImageRequest(input) + return out, req.Send() +} + +// CopyWorkspaceImageWithContext is the same as CopyWorkspaceImage with the addition of +// the ability to pass a context and additional request options. +// +// See CopyWorkspaceImage for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *WorkSpaces) CopyWorkspaceImageWithContext(ctx aws.Context, input *CopyWorkspaceImageInput, opts ...request.Option) (*CopyWorkspaceImageOutput, error) { + req, out := c.CopyWorkspaceImageRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateIpGroup = "CreateIpGroup" // CreateIpGroupRequest generates a "aws/request.Request" representing the @@ -696,7 +793,8 @@ func (c *WorkSpaces) DeleteWorkspaceImageRequest(input *DeleteWorkspaceImageInpu // DeleteWorkspaceImage API operation for Amazon WorkSpaces. // // Deletes the specified image from your account. To delete an image, you must -// first delete any bundles that are associated with the image. +// first delete any bundles that are associated with the image and un-share +// the image if it is shared with other accounts. // // 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 @@ -2318,8 +2416,9 @@ func (c *WorkSpaces) ModifyWorkspaceStateRequest(input *ModifyWorkspaceStateInpu // // To maintain a WorkSpace without being interrupted, set the WorkSpace state // to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests -// to reboot, stop, start, or rebuild. An AutoStop WorkSpace in this state is -// not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE state. +// to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this +// state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE +// state. // // 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 @@ -3226,6 +3325,132 @@ func (s *ComputeType) SetName(v string) *ComputeType { return s } +type CopyWorkspaceImageInput struct { + _ struct{} `type:"structure"` + + // A description of the image. + Description *string `min:"1" type:"string"` + + // The name of the image. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The identifier of the source image. + // + // SourceImageId is a required field + SourceImageId *string `type:"string" required:"true"` + + // The identifier of the source Region. + // + // SourceRegion is a required field + SourceRegion *string `min:"1" type:"string" required:"true"` + + // The tags for the image. + Tags []*Tag `type:"list"` +} + +// String returns the string representation +func (s CopyWorkspaceImageInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CopyWorkspaceImageInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CopyWorkspaceImageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CopyWorkspaceImageInput"} + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.SourceImageId == nil { + invalidParams.Add(request.NewErrParamRequired("SourceImageId")) + } + if s.SourceRegion == nil { + invalidParams.Add(request.NewErrParamRequired("SourceRegion")) + } + if s.SourceRegion != nil && len(*s.SourceRegion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceRegion", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *CopyWorkspaceImageInput) SetDescription(v string) *CopyWorkspaceImageInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CopyWorkspaceImageInput) SetName(v string) *CopyWorkspaceImageInput { + s.Name = &v + return s +} + +// SetSourceImageId sets the SourceImageId field's value. +func (s *CopyWorkspaceImageInput) SetSourceImageId(v string) *CopyWorkspaceImageInput { + s.SourceImageId = &v + return s +} + +// SetSourceRegion sets the SourceRegion field's value. +func (s *CopyWorkspaceImageInput) SetSourceRegion(v string) *CopyWorkspaceImageInput { + s.SourceRegion = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CopyWorkspaceImageInput) SetTags(v []*Tag) *CopyWorkspaceImageInput { + s.Tags = v + return s +} + +type CopyWorkspaceImageOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the image. + ImageId *string `type:"string"` +} + +// String returns the string representation +func (s CopyWorkspaceImageOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CopyWorkspaceImageOutput) GoString() string { + return s.String() +} + +// SetImageId sets the ImageId field's value. +func (s *CopyWorkspaceImageOutput) SetImageId(v string) *CopyWorkspaceImageOutput { + s.ImageId = &v + return s +} + type CreateIpGroupInput struct { _ struct{} `type:"structure"` @@ -5490,9 +5715,6 @@ func (s *RebuildRequest) SetWorkspaceId(v string) *RebuildRequest { type RebuildWorkspacesInput struct { _ struct{} `type:"structure"` - // Reserved. - AdditionalInfo *string `type:"string"` - // The WorkSpace to rebuild. You can specify a single WorkSpace. // // RebuildWorkspaceRequests is a required field @@ -5535,12 +5757,6 @@ func (s *RebuildWorkspacesInput) Validate() error { return nil } -// SetAdditionalInfo sets the AdditionalInfo field's value. -func (s *RebuildWorkspacesInput) SetAdditionalInfo(v string) *RebuildWorkspacesInput { - s.AdditionalInfo = &v - return s -} - // SetRebuildWorkspaceRequests sets the RebuildWorkspaceRequests field's value. func (s *RebuildWorkspacesInput) SetRebuildWorkspaceRequests(v []*RebuildRequest) *RebuildWorkspacesInput { s.RebuildWorkspaceRequests = v diff --git a/vendor/modules.txt b/vendor/modules.txt index 951f18d66ae..2a38c1ace4b 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -21,7 +21,7 @@ github.com/apparentlymart/go-cidr/cidr github.com/apparentlymart/go-textseg/textseg # github.com/armon/go-radix v1.0.0 github.com/armon/go-radix -# github.com/aws/aws-sdk-go v1.20.8 +# github.com/aws/aws-sdk-go v1.20.12 github.com/aws/aws-sdk-go/aws github.com/aws/aws-sdk-go/aws/arn github.com/aws/aws-sdk-go/aws/awserr